Windows | Microsoft Windows 2008 or higher |
| 
Internet Information Services | 8.0 or higher |
{% hint style="warning" %}
IIS need to be enabled on the server where Qommentary will be hosted. For a full list of required IIS features, please refer to our guide.
{% endhint %}
#### Database
Qommentary support the following databases:
| Database | Version |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| 
PostgreSQL (default) | 9.0 or higher |
{% hint style="info" %}
If desired, a new PostgreSQL instance can be fresh installed or connect to an excising instance during the installation wizard.
{% endhint %}
#### Ports
A Qommentary deployment requires 2 components to be hosted on-premises: the Qommentary Engine and the Qommentary Manager.
These components communicate internally behind the firewall via dedicated ports and **no connection to the internet** is required.
The following ports need to be opened **inbound** on the server where Qommentary would be hosted:
| Qommentary Engine | 5004 |
| ------------------ | ---- |
| Qommentary Manager | 5006 |
{% hint style="info" %}
If desired, ports can be changed during installation.
{% endhint %}
The following ports need to be opened **inbound** on the server where Qlik Sense is hosted:
| Qlik Repository Service (QRS) | 4242 |
| ----------------------------- | ---- |
| Qlik Proxy Service (QPS) | 4243 |
# Client Certificates
The Qlik Sense Client certificate is required for Qommentary Engine to authenticate successfully with the Qlik Sense APIs.
### Exporting Qlik Sense certificates
Firstly, let's export the Qlik Sense certificates to a new folder:
1\. Login to QMC\
2\. Go to the **Certificates** section\
3\. Fill out the required Export information
{% hint style="success" %}
Make sure you tick the *Include secret key* option.
{% endhint %}
4\. Open the disk location where certificates were exported and copy the **client.pfx** certificate to the server where Qommentary will be hosted.
### Importing Qlik Client certificate
Secondly, we'll import the newly exported certificate to the Qommentary server.
1\. Double-click on the client.pfx certificate or right-click and choose **Install PFX**\
2\. Choose **Local Machine** as the store location and click Next
3\. Leave the file name default to the current location and click **Next**
4\. Leave the default option selected and click **Next**
5\. Click **Finish** to finalize the certificate import wizard
You should now see the Qlik client certificate imported in the Personal Certificates folder
# Software dependencies
List of software dependencies used by Qommentary to function
During the installation, the setup wizard will **automatically** install all software required for Qommentary to operate properly.
{% hint style="warning" %}
You **are not** required to manually download and install software dependencies. This is an automated process carried out during first installation.
{% endhint %}
If any of these dependencies shall become corrupted during installation or upgrade, please follow these instructions to restore the affected software:
* Internet Information Services
* Web Platform Installer (IIS)
* URL Rewrite (IIS)
* .NET Core Hosting Bundle
* PostgreSQL
* SQL Server (optional)
### Internet Information Services
1\. Use the Add Roles and Features wizard from the Manage menu or the link in Server Manager. On the Server Roles step, check the box for Web Server (IIS).
2\. After the Features step, the Role services step loads for Web Server (IIS). Select the IIS role services desired or accept the default role services provided.
### Web Platform Installer (IIS)
1\. Download and install the Web Platform Installer from the following location:
3\. Click on **Bindings** under *Actions*
\
\
4\. Select the https binding and click on **Edit**
5\. Select the trusted SSL certificate you wish to apply
6\. Click **OK**
Repeat the process with the Qommentary Manager site bindings.
# Uninstalling
If you wish to delete Qommentary from your environment, you will need to go through the uninstall process.
1\. Open the Program and Features window by searching for **Uninstall a program**
2\. Search for Qommentary\
3\. Click on **Uninstall/Change**\
4\. Tick the checkbox if you wish to also delete the database and logs
5\. Click on **Uninstall**
{% hint style="info" %}
Note that the QlikClient certificate is not removed from the system
{% endhint %}
# Configuration
Every Qommentary component has a configuration file which stores important environment information.
If you need to update the configuration files with new environment details, please see below:
### Qommentary Engine
**JSON (appsettings.json)**
Compatible
However, Qlik extended CSRF protection to WebSocket connections for enhanced security which impacts external applications connecting to Qlik Sense (i.e. QAC).
Try repairing Microsoft Visual C++ Redistributable (x64). If you encounter any issues repairing the component, it might be related to missing Windows updates. Try updating Windows and repairing the component again
* **QlikClient certificate is not installed**
Export certificates from Qlik Sense and install client.pfx
* **URL Rewrite version not compatible with Windows version**
1\. Open Event Viewer\
2\. Select Application Logs\
3\. Check if there's any errors related to rewrite.dll failing to load
Install the supported URL Rewrite module included in the Software Dependencies section.
### 415 Method Not Allowed
**Problem**\
Extension hangs on spinning wheel when trying to update or delete a commentary.
**Possible cause**\
Wev Dav might be enabled in IIS and is interfering with PUT and DELETE methods.
To disable the module, follow these steps:
1. Open Server Manager
2. Click on Add Roles and Features
3. Jump to Server Roles
4. Look for *Web Server (IIS) > Web Server > Common HTTP features*
5. Untick WebDAV Publishing
6. Click on Next and Install
For more information on disabling Web Dav in IIS, please refer to this [guide](https://inedo.com/support/kb/1140/disabling-webdav-in-iis).
### ERR CERT COMMON NAME INVALID
4. Search and open the **web.config** file\ \  5. Change the *stdoutLogEnabled* to **true**\
# Qlik Sense connectivity 1. Download and install [Postman](https://www.postman.com/downloads/) on the Qommentary instance 2. Download the [Postman Qlik Sense QRS API collection](https://www.qommentary.com/downloads/postman/Qlik%20Sense%20QRS%20API.postman_collection.json) 3. Launch Postman 4. Go to **File > Import** and load the *Qlik Sense QRS API collection* 5. Update the hostname to reflect your environment
Qommentary Writeback
### Pinned Columns for Better Visibility and Improved Workflows
We’ve added the ability to **pin columns** in writeback tables, ensuring that important data remains visible while scrolling.
This enhancement improves navigation by keeping key fields, such as IDs or statuses, locked in place for quick reference. It also enhances data entry by maintaining context, reducing errors, and increasing productivity.
With the flexibility to pin only the columns you need, you can create a more customized and efficient table experience.
### Dynamic Column Visibility for Enhanced Data Clarity
We’ve enhanced column visibility in the Qommentary Writeback Table, allowing users to show or hide **dimension, measure, and writeback columns** based on business logic.
Previously limited to writeback columns, this update ensures that only the most relevant data is displayed, improving clarity and focus. Users can tailor views for role-based access, context-specific filtering, and conditional visibility—such as displaying a “Discount” column only when a promotion applies.
By reducing clutter and streamlining data entry, this feature enhances usability, making data analysis more efficient and intuitive.
### Cascading Dropdowns for Context-Aware Selections
We’ve introduced **cascading dropdowns** in the Qommentary Writeback Table, enabling dropdown values to be dynamically filtered based on selections in another dropdown.
This enhancement allows users to create a more structured and intuitive data entry experience by ensuring that selections are contextually relevant. Dropdown values can still be manually defined or sourced from a Qlik Sense dimension, but now, with cascading filtering, users can drill down into their data more efficiently while reducing input errors and improving workflow accuracy.
### 
Qommentary Manager
### Comment Archiving for Enhanced Pivot Table Data Management
The **Qommentary Pivot Table** now supports **comment archiving**, allowing users to keep their data relevant and up-to-date. With this new feature, comments added at any intersection can be archived, ensuring that outdated or irrelevant information is removed while preserving necessary context and explanations.
Previously available in **Qommentary Insights** and **Qommentary Table**, this feature is now extended to the **Pivot Table**, enhancing data management and streamlining collaboration by keeping tables clear and focused.
### Enhanced Enterprise Licensing: Unlimited Access for All Users
We’ve introduced a new **Enterprise** license type **-** providing **seamless, unlimited access** to all users. With this new license type, there’s **no need for manual token allocation**, simplifying administration and ensuring everyone has the access they need—instantly.
# v25.1.1
## Bug Fixes
### 
Qommentary Writeback
**\[QOM-1975] Missing input columns in legacy writeback tables**
Resolved an issue where input columns were disappearing from the main table after the introduction of conditional column display. This bug affected Qommentary Writeback tables created with versions earlier than 25.1.0.
# v23.2.0
## Bug Fixes
### 
Qommentary Table
#### \[QOM-1915] Header column and row misalignment
Fixed an issue which caused the table header columns and rows to become misaligned when multiple columns were added.
#### \[QOM-1916] Long text in cell overlaps
Fixed an issue which only impacted dimension cells with long single-string characters causing text to overlap on top of the next column when there wasn't enough space available.
#### \[QOM-1917] Column dimension search not applying selections
Fixed an issue which prevented selections from being applied when searching in column dimensions. Clicking on any dimension would not apply any filters to the existing dataset.
### Qommentary Writeback
#### \[QOM-1914] Display date dimensions in the specified format
Resolved an issue which caused date dimension values to display in numeric format, rather than the specified formatted option.
## New Features and Enhancements
### 
Qommentary Insights
#### Display titles of charts referenced by commentaries
Qommentary Insights allows you to add additional context to your commentaries by referencing sheet charts which you want to bring up during discussion. This new feature now also displays the title, subtitle and footer which have been added to the original chart.
#### Customize commentary icon appearance
In some scenarios, it is useful to maximize sheet real estate and display commentary as a chat bubble icon, rather than a full text editor. Now you can further personalize the user experience by customizing the chat bubble icon's color, background color and shape. Great for adhering with branding guidelines!
#### Create private conversations around data points
Unlock the power of personalized communication! In this release, we've transformed the commenting experience to elevate your interactions. Say goodbye to the limitations of public discussions – now, you have the power to choose between two dynamic comment creation methods: Quick and Advanced.
With the Quick method, keep the channel open and send messages effortlessly triggering rapid communication. Meanwhile, the Advanced method empowers you with enhanced controls, enabling you to tailor your comments as public (for everyone to see), private (exclusively for your eyes only), or selectively shared with specific individuals you invite to the conversation.
#### Organize your conversations neatly using comment reply threads
We're taking business discussions to a whole new level! Replies in comment threads enhance engagement, streamline communication, and foster a sense of community by allowing users to address specific points, creating a more organized and personalized interaction within the broader conversation.
### Qommentary Table
#### Pinning favorite columns to table
Exciting news! Our latest update introduces a fantastic new feature designed to elevate your workflow and boost productivity. Now, you can effortlessly pin columns for quick reference and enhanced context within our user-friendly interface. Experience the convenience of having key information right at your fingertips, making data analysis a breeze.
#### Horizontal and vertical alignment control on cells
Now, you have the power to finely tune the presentation of your data with the introduction of text alignment control in both horizontal and vertical dimensions, all conveniently accessible through the Properties Panel.
#### Row font size control
We keep introducing more ways to customize your tables! With just a few clicks in the Properties Panel, you can effortlessly adjust the font size for text in rows, allowing you to create documents that are not only informative but visually stunning. Tailor your content to perfection, ensuring every detail is presented with precision and flair.
### Qommentary Writeback
#### SQL Server connections with Windows Authentication
Enterprises love connecting to databases using a variety of authentication mechanisms. In this release we're introducing by popular demand a new way to establish a SQL Server connection using Windows Authentication.
# v23.1.0
## Bug Fixes
### Qommentary Table
#### \[QOM-1744] Column sorting not working consistently
Fixed an issue which prevented column sorting when clicking across various table headers.
#### \[QOM-1786] Comment RTE not loading
Fixed an issue which caused the RTE in the New Comment dialog to not load properly. This impacted in the creation of new table comments.
#### \[QOM-1834] Comment list not refreshing after new comment
Fixed an issue which prevented the list of comments in any given row to refresh when a new comment was added. The workaround required to close the Comments Dialog and re-open it.
## Features
### Qommentary Table
#### \[QOM-9] Re-order dimensions and measures
We have introduced a new data "Columns" structure, which now allows dimensions and measures to be re-ordered interchangeably gaining maximum flexibility and opening up new use cases.
### Qommentary Writeback
#### \[QOM-1684/85] Edit or Delete Data Connections privileges
Previously if you had Manage Writeback permissions on a stream, app or sheet level - you were able to edit or delete data connections. We have now de-coupled this from the Manage Writeback permission and introduced a new Data Connections Admin role and Data Connections security rules. When used in combination, these operations would be available only to users who fulfil these conditions.
#### \[QOM-1745] Create Data Connection privileges
Previously if you had Manage Writeback permissions on a stream, app or sheet level - you were able to create/delete writeback data as well as create data connections. We have now de-coupled creating data connections from the Manage Writeback permission and introduced a new Data Connections Admin role.
#### \[QOM-1772] Display Grand Totals on Numberic input fields
Just like with Measure columns, Grand Totals is now also displayed for numeric input fields in the Writeback table.
#### \[QOM-1787] Number input formatting options
We have added a range of number formatting options for numeric input fields to better accommodate your use cases - including number comma, percentage, currency, date and duration formatting.
### 
Qommentary Form
#### \[QOM-1732/33] Edit or Delete Data Connections privileges
Previously if you had Manage Writeback permissions on a stream, app or sheet level - you were able to edit or delete data connections. We have now de-coupled this from the Manage Writeback permission and introduced a new Data Connections Admin role and Data Connections security rules. When used in combination, these operations would be available only to users who fulfil these conditions.
#### \[QOM-1743] Create Data Connection privileges
Previously if you had Manage Writeback permissions on a stream, app or sheet level - you were able to create/delete writeback data as well as create data connections. We have now de-coupled creating data connections from the Manage Writeback permission and introduced a new Data Connections Admin role.
### 
Qommentary Pivot Table
#### \[QOM-1820] Include associated dimensions when exporting comments
When Pivot Table comments are exported via the QAC, the associated cell dimensions are now also being included in the output Excel. This adds additional context to the exported dataset which is key to understanding the whole story and making better informed decisions.
### Qommentary Manager
#### \[QOM-1681] Data Connections security rules
Previously, all users were allowed to choose any data connection to use in Qommentary Writeback or Form use cases. We have now introduced more control and governance around data connections visibility, allowing Data Connection security rules to be created.
#### \[QOM-1738] Data Connections Admin role
We've introduced a new "Data Connections Admin" role which is allocated to users who need permissions to create, edit or delete data connections in Qommentary.
#### \[QOM-1808] Search, filter and manage Pivot Table comments in the QAC
Just like with Qommentary Insights and Table, you can now conveniently search, filter and manage all your Pivot Table comments from a single location in the QAC. You can also archive comments which are no longer required or export data to Excel to use as an additional data source, share with stakeholders or store offline.
# v23.1.1
## Bug Fixes
### Qommentary Table
#### \[QOM-1911] Cannot view or add dimensions and/or measures
Fixed an issue which impacted existing extensions causing the table dimensions/measures from disappearing from the data section and prevented adding new ones.
### Qommentary Writeback
#### \[QOM-1914] Dimension date values display in numeric format
Fixed an issue which displayed all date dimensions in it's numeric format, instead of formatted dates.
#### \[QOM-1912] Selections on table dimensions not working
Fixed an issue which prevented table dimensions from being selected and filtered.
#### \[QOM-1913] Column search not working
Fixed an issue which impacted the table column search functionality and prevented the dimension filter popup from appearing.
# v23.1.2
## Bug Fixes
### Qommentary Writeback
#### \[QOM-1928] Grand totals in writeback columns not updating
Remediated an issue which caused the writeback column grand totals not to update when data was filtered in the Qlik Sense data model. Now, as you filter data, grand totals are recalculated and values displayed for the filtered dataset.
# v23.1.3
## Bug Fixes
### Qommentary Writeback
#### \[QOM-1931] Expression field inconsistent rounding
Resolved an issue in the Expression Field that caused inconsistent rounding of decimal values. To address this, we’ve added new number formatting controls to provide more consistent and precise results.
#### \[QOM-1932] Cursor position retained when deleting digits in long numbers
Fixed an issue where the cursor would reset to the end of a long number when deleting a digit. Now, the cursor will remain in place, allowing for easier edits within the number field.
### Qommentary Table
#### \[QOM-1930] Exporting data to Excel from multiple tables in one sheet
Resolved an issue where exporting data to Excel from multiple table instances on the same sheet would only export data from the last table. Now, each table exports its unique data correctly, allowing for individual table data exports as expected.
## Features
### Qommentary Insights
#### \[QOM-1946] Enhanced commentary input with concurrent edit validation
Qommentary Insights now supports safe text input and saving within your analytics dashboards. Previously, simultaneous commentary updates by multiple users could lead to messages being overwritten. With this new feature, a validation warning alerts users if another commentary has been added, prompting them to refresh to view the latest input, ensuring data integrity and collaboration without conflicts.
# v23.1.4
## Bug Fixes
### Qommentary Table
#### \[QOM-1947] Commentary override
Fixed an issue where, in cases of simultaneous commentary edits by multiple users, one user’s commentary was unintentionally overwritten by another’s without a proper warning.
This fix introduces a validation modal to alert users when there is a conflicting edit. The warning will now appear when two users try to edit and save the same commentary with identical selections at the same time. The system captures a snapshot of the commentary upon loading and compares it with the commentary at the time of saving. If discrepancies are detected, the user is prompted to refresh to view the latest updates before saving.
## Features
### Qommentary Table
#### \[QOM-1949] Cell line truncation control
Added a new feature that allows users to control the number of lines displayed for cell content within tables. This enhancement provides greater flexibility in content management, enabling users to adjust table content visibility according to their preferences and optimize readability.
# v22.3.0
## What's new?
The Qommentary team is extremely proud to introduce the highly-acclaimed Qommentary Form Extension to the Qommentary library!
Traditionally, data input and master data management is done in external tools and platforms which are usually clunky and incur cost, time and effort to setup and maintain.
The *Qommentary Form Extension* is a revolutionary data entry tool which allows users to quickly create and manage highly-customizable input forms, directly in Qlik Sense. Data can be stored in a wide range of databases with writeback capabilities.
### Qommentary Form
Qommentary Insights
#### \[QOM-1023] Share modal displays preloader behind elements
Fixed a layering issue which caused the "loading" icon to be displayed behind the dropdown elements in the modal.
### Qommentary Table
#### \[QOM-307] Wrong error message displayed when subscription license expired
Fixed an issue which displayed an irrelevant message when the subscription license expired.
#### \[QOM-1076] Table data not refreshed when resizing in Edit mode
Fixed an issue which affected the table data being refreshed when resizing extension in Edit mode.
### Qommentary Writeback
#### \[QOM-1405] Column search not working
Fixed an issue which affected the field search feature in column headers when the dimension field name was different than the label name.
## Features
### Qommentary Pivot Table
#### \[QOM-1334] New user experience when pivoting dimensions
We have introduced a better way of drag and dropping dimensions between rows and columns, which allows multiple dimensions to wrap in a grid-like layout, rather than being displayed horizontally in a single row. This provides an enhanced user experience for one of the most commonly used behaviours in a Pivot Table.
### Qommentary Manager
#### \[QOM-1352] Support for license downgrading
We introduced support for license de-allocation which would be required when downgrading from a higher pool of user tokens to a lower one. This feature now allows Qommentary Admins to de-allocate user tokens until the valid limit is reached before the new license can be activated.
# v22.1.0
## What's new?
In the January 2022 release we are extremely excited to introduce the new *Qommentary Pivot Table* extension to the Qommentary library.
The *Qommentary Pivot Table* extension allows teams to leverage the power of a Qlik Sense native pivot table, combined with the ability to collaborate by adding multiple comments on cells - on any data intersection.
### Qommentary Pivot Table
Check out the *Qommentary Pivot Table User Guide* to [learn more](https://knowledgebase.qommentary.com/qommentary-pivot-table/).
## Bug Fixes
### Qommentary Writeback
#### \[QOM-1130] Export after re-ordering columns displays invalid data
Fixed an export data issue which caused values in Excel to be displayed in the incorrect columns if input columns where re-ordered prior to exporting.
#### \[QOM-1132] Enabling concurrency hangs extension
Fixed an issue which caused the extension to hang if concurrency was enabled.
#### \[QOM-1133] Country dropdown list cutting off long names on export
Fixed a data export issue with the Dropdown component (Country type) which cut-off countries with long names when exported to Excel.
## Features
### Qommentary Writeback
#### \[QOM-1112] Audit columns
Now you can easily add system info to your tables by automatically displaying the last updated username and date. A great way to keep track of changes!
#### \[QOM-1125] Expression Input Control
The Expression Input Control allows you to leverage Qlik Sense expressions to reference values not only from dimension and measure columns, but also custom writeback input columns. A powerful way to display columns with calculated formulas on-the-fly.
####
# v21.4.0
## Bug Fixes
### 
Qommentary Table
#### \[QOM-1046] Comments loading inconsistently
Fixed an issue which caused comments to be loaded inconsistently when toggling through multiple selections repeatedly and in short delays.
#### \[QOM-1043] Saving comments with blank dimensions in row
Fixed an issue which prevented from saving new comments when the affected row had dimensions with blank values.
### 
Qommentary Writeback
#### \[QOM-1041] Invalid date format in datepicker control
Fixed an issue which caused dates in fields to display in an invalid format when using custom format 'dd/mmm/yyyy'.
#### \[QOM-1040] Search disappears in Select Existing Connection modal
Fixed an issue in the Select Existing Connection modal which caused the search field to disappear when searching for invalid data connections.
#### \[QOM-1078] Dropdown dimension does not load when selections applied
Fixed an issue in the dropdown dimension control which caused the values not to load when selections were made to the same dimension on a Qlik Sense filter or other chart.
## Features
### Qommentary Writeback
#### \[QOM-941] New ODBC data connection
Introduced a new ODBC (64 bits) data connection to allow you to save writeback data in any database of your choice.
#### \[QOM-942] New Teradata data connection
Introduced a new Teradata data connection to allow you to save writeback data in your own Teradata databases.
# v21.4.1
## Bug Fixes
### Qommentary Writeback
#### \[QOM-857] Number component with type integer allowing decimal places
Fixed a validation issue which allowed decimals to be entered in integer input fields.
#### \[QOM-1090] Checkbox controls saving false values as null
Fixed a data issue which caused Checkbox controls to save unchecked values as null.
### 
Qommentary Engine
#### \[QOM-1091] CORS issue with same origin sites
With the upgrade of .NET Core Hosting bundle to version 3.1.x, Microsoft introduced stricter restrictions which required same-origin sites accessing the Qommentary Engine to be whitelisted. This fix ensures that same-origin sites can establish communication without any CORS issues.
# v21.3.0
## [Bug Fixes](https://knowledgebase.qommentary.com/support/release-notes/apr-2021-21.2.2#bug-fixes)
### 
Qommentary Insights
#### \[QOM-885] User and group picker in share modal
Fixed a layer display issue with the user and group picker which was hiding behind the modal window.
### Qommentary Table
#### \[QOM-876] Table hangs when mentioning users on first comment
Fixed an issue which caused the loading spinner to hang when adding a first comment which had a mentioned user.
### Qommentary Writeback
#### \[QOM-765] Sort icon disappearing
Fixed an issue which caused the sort icon to hide or display incorrectly. Sort icon will now adopt the text colour set on the header or totals row - depending on the sorting direction.
#### \[QOM-928] Long values in dropdown options wrap
Fixed an issue with dropdown controls when applying very long text options which caused the values to wrap into 2 or more lines and break the UI layout.
#### \[QOM-925] Export date displayed as number
Fixed an issue with exporting writeback table data to Excel which caused the date fields to be displayed in it's numeric representation.
#### \[QOM-932] Disable selections on measures
Disabled selections on measures which resulted on an "Invalid parameters" error being displayed.
#### \[QOM-933] Custom colours in header not applying
Fixed an issue with the custom text and background colours for table headers not appearing.
## [Features](https://knowledgebase.qommentary.com/support/release-notes/jun-2021-21.3.0#features)
### Qommentary Insights
#### \[QOM-850] Enable export control
Added a new property to enable or disable commentary exporting functionality.
### Qommentary Writeback
#### \[QOM-840] Enable bulk edit controls
Added new properties to enable or disable bulk column and/or advance bulk update operations in the table.
#### \[QOM-881] Reference input column values from expressions
Enhanced flexibility and user experience to enable or disable editing of input columns based on expressions which can reference values from other input columns.
#### \[QOM-905] Header height control
Introduced new controls to customize the header height, choosing from 3 options: compact, comfortable or spacious. The height selected will also determine if 1, 2 or 3 lines of text can be displayed.
#### \[QOM-922] Dropdown control with dimension values
We're introducing a new way to source values for your dropdown input controls - sourced directly from Qlik Sense dimensions. This allows you to leverage pre-existing fields in the data model to drive dropdown options presented to users.
#### \[QOM-925] Export date display format
Added new properties to show/hide export function and also determine if the exported date fields should display with locale format or as per Qlik Sense.
#### \[QOM-931] Disable create, edit or delete connections for unauthorized users
Added new security controls to disable unauthorized users from creating, editing or deleting data connections in published applications.
## [Improvements](https://knowledgebase.qommentary.com/support/release-notes/apr-2021-21.2.2#improvements)
### Qommentary Insights
#### \[QOM-872, QOM-873] Allow export and share for unlicensed users
We keep adding more freemium features to our Qommentary extensions, now allowing non-licensed users to export and share commentary data.
### Qommentary Writeback
#### \[QOM-899] Added input control field name validation
Added new validation in table and properties panel if input control field name is left blank.
#### \[QOM-905] New sticky header rendering mechanism
We improved the stability and consistency of the table sticky header by re-building it from scratch with a new more powerful approach.
#### \[QOM-962] Added audit table name validation
Added new validation in table and properties panel if audit logs table name is empty or contains spaces.
### Qommentary Engine
#### \[QOM-896] Improved performance for syncing large number of users
We've added significant performance improvements in the user synching process to handle large number of users (+10,000) when triggered from the Qommentary Admin Console or the User Sync Utility.
#### \[QOM-924] Syncing AD groups ignoring case-sensitivity
To further align with Qlik Sense's rules when importing user attributes, we are now allowing non case-sensitive groups to be synced into your Qommentary environment.
# v21.2.0
# v21.2.1
## [Bug Fixes](https://knowledgebase.qommentary.com/support/release-notes/apr-2021-21.2.2#bug-fixes)
### Qommentary Writeback
#### \[QOM-849] Display correct success notification
Fixed an issue when editing a data connection which caused the success notification to display an invalid message
### Qommentary Engine
#### \[QOM-847] Display schema warning window when using custom public schema
Fixed an issue when using a custom public schema in database data connections which caused the schema warning window to appear.
# v21.2.2
## [Bug Fixes](https://knowledgebase.qommentary.com/support/release-notes/apr-2021-21.2.2#bug-fixes)
### Qommentary Insights
#### \[QOM-861] List of users and groups in Share window not showing
Fixed an issue with the commentary share functionality which caused the list of searched users or groups to disappear.
## [Improvements](https://knowledgebase.qommentary.com/support/release-notes/apr-2021-21.2.2#improvements)
### Qommentary Engine
#### \[QOM-865] Display all users and groups by default
Introduced a new default behaviour which allows any user to view all system's users and/or groups if custom security rules are not present or disabled.
# v21.1.0
## [Features](https://knowledgebase.qommentary.com/release-notes/jan-2021/jan-2021-v21.1.0#features)
### Qommentary Manager
#### \[QOM-686] New Developer Admin role
Added a new type of role which grants permissions to manage Invalid Resources in the Qommentary Admin Console. Invalid Resources allows restoring commentary references from applications and/or objects which were previously deleted.
#### \[QOM-689] Bulk group license allocation
We introduced a new feature in the License Allocation section to allow tokens to be bulk allocated to selected groups. De-allocation of tokens is still done manually for each user.
## [Improvements](https://knowledgebase.qommentary.com/release-notes/jan-2021/jan-2021-v21.1.0#improvements)
### Qommentary Manager
#### \[QOM-687] Users with Manage Security permissions can edit group roles
We extended the Manage Security permission rules to also allow the editing of custom or AD group roles.
# v21.1.1
## [Bug Fixes](https://knowledgebase.qommentary.com/release-notes/jan-2021/jan-2021-v21.1.1#bug-fixes)
### Qommentary Table
#### \[QOM-771] Mention list hides behind Add comment modal
Fixed a display issue which caused the mentions list menu to display behind the modal when adding a new comment.
#### \[QOM-772] Content library list always fetched via default virtual proxy
Fixed an issue with the Profile Photos content library in the properties which was targeting the default virtual proxy, rather than the currently selected. This caused issues if the current user did not have access to the default virtual proxy.
# v21.1.2
## [Bug Fixes](https://knowledgebase.qommentary.com/release-notes/jan-2021/jan-2021-v21.1.2#bug-fixes)
### Qommentary Engine
#### \[QOM-865] Change default security rules for users and groups
Fixed a default behaviour which prevented users and groups from being fetched across the Qommentary platform - unless implicit security rules where created targeting these resources. Now by default, all users and groups will be visible, unless security rules with specific conditions are created.
# v20.4.0
{% file src="/files/-MLptkDmG3TJXGhsMj\_-" %}
Qommentary Oct 2020 - 20.4.0
{% endfile %}
# v20.4.1
{% file src="/files/-MNzvZD7z-t7S6LsVQyA" %}
Qommentary Oct 2020 SR1 - 20.4.1
{% endfile %}
# v20.3.0
{% file src="/files/-MLzKmYpKkIOmhvGjaxk" %}
Qommentary Sep 2020 (20.3.0) Release notes
{% endfile %}
# v20.2.0
## Bug Fixes
### Qommentary Insights
#### \[QOM-179] Extension registration in workarea mode
Fixed an issue which caused new extensions added to register in workarea applications, experiencing unexpected behaviours when searching for published commentaries.
#### \[QOM-227] Replace underscore methods to avoid conflicts with 3rd party extensions
Replaced underscore methods which caused extension to crash when used in conjunction with 3rd party extensions.
#### \[QOM-277] Prohibit commentary entry when global commentary is disabled
Fixed an issue which allowed commentary to be entered when no selections were applied and “allow global commentary“ was disabled.
#### \[QOM-244] Extension version displaying incorrectly
Fixed an issue when upgrading to a new version, which caused existing extensions instances to display an older release and version number.
### Qommentary Table
#### \[QOM-226] Replace underscore methods to avoid conflicts with 3rd party extensions
Replaced underscore methods which caused extension to crash when used in conjunction with 3rd party extensions.
#### \[QOM-234] Incorrect sort order when adding new comments
Fixed a bug which caused comments on row detail view to be displayed in incorrect sort order when a new comment was added
#### \[QOM-244] Extension version displaying incorrectly
Fixed an issue when upgrading to a new version, which caused existing extensions instances to display an older release and version number.
### Qommentary Admin Console
#### \[QOM-178] Avoid updating roles for security admins
Fixed an issue affecting users with Security Admin privileges which caused assigned admin roles to be revoked when editing and saving user attributes.
#### \[QOM-180] Avoid updating for roles security admins
Fixed an issue which allowed Security Admins to update admin roles assigned to AD groups
#### \[QOM-194] User/group search cuts out long results
Fixed a UI bug which cause long user or group names to be cut out when searching on dropdowns
#### \[QOM-267] Error handling user sync
Fixed an issue which gave a false positive when syncing users on first attempt.
#### \[QOM-181] Editor Admins visibility to archived commentaries
Fixed an issue which prevented Editor Admins from accessing the archived commentaries section.
### Qommentary Engine
#### \[QOM-263] User sync utility logging
Fixed an issue with the log path location for the User Sync Utility which caused the utility to skip writing logs to file system.
## New Features
### Qommentary Insights
#### \[QOM-238] Qlik NPrinting compatibility
Introduced full compatibility between Qlik NPrinting and Qommentary - allowing any commentary associated to selections to be embedded in NPrinting reports and distributed on a scheduled task.
#### \[QOM-202] Submit for approval permission
Added a new type of permission which allows privileged users to submit commentary for approval.
#### \[QOM-205] Recall permission
Added a new type of permission which allows privileged users to recall commentary which was published or submitted for approval.
#### \[QOM-203] Dimensions and anchor point controls for non-responsive sheets
Added properties to specify width/height dimensions and position anchor points when writing commentary in full screen mode.
### Qommentary Table
#### \[QOM-278] Display first or last comment in Comments column
Added properties for controlling visibility of comment in Comments column and if first or last comment should be displayed.
### Qommentary Admin Console
\[QOM-119] Comments search and archive
Added a new section to the Qommentary Manager which separates commentaries (narratives) from comments (discussions, table comments) - allowing you to search and archive comments written in all extensions.
#### \[QOM-137] SMTP SSL and TLS options
Added new options to specify if SMTP connection uses SSL or TLS.
#### \[QOM-138] SMTP validate email settings
New handy feature which allows testing and validating settings and connection to the SMTP server.
#### \[QOM-214] Export workflow data to XML
New convenient way of generating a full data definition of the Workflows section, exported to XML format. The downloaded document contains such information as workflow name, description, associated resources and steps of approval.
#### \[QOM-233] Invalid resources recovery section
Any Qlik Sense resource (stream, app or sheet) associated to a Qommentary instance saves a reference. If one of those resources are permanently deleted, the commentary reference would be destroyed.
This new section will allow broken Qommentary instances to be re-mapped to new Qlik Sense resources, allowing the recovery of commentary and restoring to previous state.
### Qommentary Engine
#### \[QOM-221] Audit log for user-driven actions
Added logging capabilities to track and monitor relevant user actions in Qommentary. Logs are generated in txt format and saved in the configured log path location.
#### \[QOM-118] Support for DB column-level encryption
Introduced support for column-level encryption (PostgreSQL)
# Deployments
A high-level diagram of the Qommentary architecture and deployment options
### Components
Qommentary has four main components:
* **Qommentary Extensions**\
*The Qlik Sense extensions deployed using the QMC** **Qommentary Manager**\ *The main administration console which allows you to control the Qommentary environment*
* **Qommentary Engine**\ *The main API component responsible for managing commentary, security, workflows, etc.*
* **Qommentary Database**\ *The PostgreSQL database where Qommentary data is stored and retrieved.*  ### Deployments Qommentary offers multiple options when it comes to deploying across environments: | Scenario | Component | Deployment | | ----------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | Qlik Sense shared |
Qommentary Engine/Manager
Qommentary Database
|Same environment as Qlik Sense
Connects to same instance as Qlik Sense
| | Qlik Sense shared |Qommentary Engine/Manager
Qommentary Database
|Same environment as Qlik Sense
Connects to new internal or external instance
| | Dedicated |Qommentary Engine/Manager
Qommentary Database
|Dedicated environment
Connects to same instance as Qlik Sense
| | Dedicated |Qommentary Engine/Manager
Qommentary Database
|Dedicated environment
Connects to new internal or external instance
| # Disaster Recovery Disaster recovery (DR) means being prepared for—and recovering from—disaster. Any event such as hardware failure, software failure, natural calamity, human error, or infrastructure failure that causes disruption to business continuity can be considered a disaster. ### Backing up a Qommentary site A Qommentary site backup includes: **Qommentary database** - The central database containing all user data and configuration. Regular backups should be conducted to avoid data loss. **Qlik Sense Client certificate** - Qommentary uses the Qlik Sense Client certificate to authenticate with Qlik Sense API services. **SSL certificate** - Any 3rd-party SSL certificate used to secure connection with the Qommentary Engine and Qommentary Manager. ### Restoring a Qommentary site After restoring Qlik Sense back to it's original snapshot state prior to the event, you will need to restore Qommentary back to normal. Please follow these steps to restore Qommentary: 1\. Install Qommentary on the recovery environment using the *Qommentary Setup Wizard*\ 2\. Restore the Qommentary Database from the latest snapshot\ 3\. Re-install the Qlik Sense Client certificate\ 4\. Re-bind the SSL certificate to the Qommentary Manager/Engine sites (if applicable) {% hint style="warning" %} It is important that applications restorted in the recovery environment retain the same application ID as prior to the incident. Qommentary associates data to applications and if the restored applications are imported manually via the QMC, the application ID will change and commentary data might loose reference. {% endhint %} # Mirroring Sites Qommentary Mirroring architecture allows you to mirrow a Qommentary environment across multiple Qlik Sense sites. This way, commentary data can be shared and managed across all sites from any location. In this type of architecture, there is a Central Node which acts as the single source of truth, and mirroring environments which communicate with the Central Node. If you would like to mirror a Qommentary enviroment, please follow these steps: ## Mirror Node Setup ### Installation 1\. Launch **Qommentary Setup Wizard** 2\. Under Database section, uncheck "Install database server" 3\. Enter **Central Node** database details and test connection 4\. Continue installation as per [Installation guide](/getting-started/installation) ### Qlik Client Certificate 1\. Navigate to *QMC > Certificates* in **Central Node** 2\. Export certificates (include secret key) 3\. Copy certificates to **Mirrow Node** 4\. Install **client.pfx** certificate under *Local Computer > Personal* store 4\. Rename QlikClient friendly name to **QlikClient\_CentralNode** ### Configuration 1\. Navigate to Qommentary installation location 2\. Open **Qommentary Engine** folder 3\. Edit **appsettings.json** with your favourite text editor 4\. Add the following code snippet to the root node: ``` "IsMirroringEnabled": true, "Mirroring": { "CentralNode": { "Url": "https://
and try again.
{% endhint %}
{% hint style="warning" %}
Currently you can assign one workflow to a resource. Once the workflow has been assigned, the checkbox will be ticked and disabled to other users.
Workflows applied to children resources will take presedence over parent resources.
{% endhint %}
### Removing resources from an approval workflow
1\. Edit a workflow from the list
2\. Click on the **Trash icon** next to the resource you would like to remove
### Adding steps to an approval workflow
When a commentary is submitted for approval, Qommentary will send email notifications to all users involved in the first step of approval.
Once the first step is approved, if the workflow has a single step of approval, a final notification will be sent to the author and the commentary would be ready to be published. Alternatively, if the workflow has multiple steps of approval, notifications will be sent to all users involved in the next step.
If at any point in time the workflow is rejected, a notification will be sent to the author an the commentary may be recalled and updated before re-submitting for approval.
To add steps to your workflow, please follow these steps:
1\. Click on the **Add step** button\
2\. Add users and/or groups required to approve the current step
{% hint style="info" %}
Check the **All must approve** option if you require all users involved in the current step to approve. By default, the first user who approves the commentary will complete the step.
{% endhint %}
3\. Click on the **Add** button\
4\. Repeat the process if you wish to add more steps to the approval workflow
### Editing a step in an approval workflow
1\. Click on the **3-dots icon** next to the step you wish to edit
2\. Click on the **Edit** button
3\. Update the required details and click on the **Save** button
### Deleting a step in an approval workflow
1\. Click on the **3-dots icon** next to the step you wish to edit
2\. Click on the **Delete** button
3\. Click on the **Delete** button to confirm
# Security Permissions
Security permissions allows you to control what actions can be performed by users in your Qommentary environment. Permissions can be applied at a stream, application, sheet or commentary level. Permissions can be assigned to multiple users and groups (custom and AD).
The Resource Directory Tree displays all resources the user is allowed to see based on the security permissions defined in Qlik Sense.
**Overview**\
The security permissions page is divided in several sections.
\
**References:**
1. Resource Directory: Full Qlik Sense directory tree based on security permissions
2. User/Groups: This section displays the Users and Groups associated to the selected resource level
3. Permissions: This section displays the Permissions for a selected User or Group and a selected resource level.
**Qommentary Insights**
| Permission | Description | |
|---|---|---|
| Create Commentary | Create a commentary | |
| Update Commentary | Update own commentaries and commentaries created by other users | |
| Delete Commentary | Delete a published commentary | |
| Publish Commentary | Publish own and other’s commentaries | |
| Approved Commentary | Approve a commentary that is under review | |
| Submit for approval | Submit a commentary for approval | |
| Recall Commentary | Recall a published commentary |
| Permission | Description | |
|---|---|---|
| Create Commentary | Add comments | |
| Update Commentary | Update comments | |
| Delete Commentary | Delete comments |
| Permission | Description | |
|---|---|---|
| Manage Writeback | • Add, update, and delete writeback data • Update metadata: add and remove columns files • Create, update, delete and remove data connections | |
| Write | Add and update writeback data | |
| Delete | Clear all writeback data |
| Permission | Description | |
|---|---|---|
| Write |
| |
| Delete | Delete own and other's comments |
| Permission | Description | |
|---|---|---|
| Delete Commentary | Read, archive, and delete commentaries and comments | |
| Manage Workflows |
| |
| Manage Security | • View users and group section • Edit user and group details, but not roles • Add and delete permissions at resource level |
| Field | Description |
|---|---|
| Field | Description |
| Logical Operator | Indicates if the conditions are exclusive or inclusive
e.g: Condition1 AND Condition2 AND Condition3 If OR is selected, the conditions are concatenated using the logical operator OR. e.g: Condition1 OR Condition2 OR Condition3 NOTE: AND and OR operators cannot be used on the same rule. |
| Resource | Indicates the resource that the condition will be targeting |
| Property | Indicates the Resource property used on the condition |
| Operator | Indicates the operator used on the condition.
NOTE: operators are case-sensitive |
| User | Represents the current user logged in when the rule is being evaluated |
| Attributes | Displays a list of Qlik Sense user attributes |
 ### Deallocating a user license To deallocate a Qommentary license from a user: 1 . Click on the **Deallocate** icon  2\. Click on the **Confirm** button  3\. The user has been deallocated # Email Notifications Qommentary built-in notification system enables users to stay connected and always in the loop. {% hint style="info" %} To configure your SMTP server settings, please refer to [Setup > SMTP Server](broken://pages/-M4vfkfGUzuS67r7_WLY) section {% endhint %} Email notifications are defined at a global level and can be customized with your organization's branded HTML templates.  ### Updating email templates 1\. Click on the **Edit** button 2\. Update template HTML on rich text editor  {% hint style="info" %} To restore a template back to it's original default state, simply click on the **Use Default** button {% endhint %} 3\. Click on **Save** button ### Template placeholder tags Email templates contain placeholder tags which are replaced with relevant information when email notifications are sent. For a full list of supported placeholder tags, please refer to below table: #### Supported tags | Tag name | Description | | --------------------------- | -------------------------------------------- | | **\[UserFullName]** | Name of notification recipient | | **\[AdminUserDisplayName]** | User who cancelled the workflow | | **\[ReviewerDisplayName]** | Name of commentary reviewer | | **\[Commentator]** | Name of user who added the comment | | **\[Sender]** | Name of user who added the comment | | **\[Link]** | URL of application shared | | **\[Message]** | Custom messaged sent by sender | | **\[StepNumber]** | Current workflow step number | | **\[SubmitterComments]** | Custom messaged sent by commentary submitter | | **\[ApprovalWorkflowName]** | Workflow name | | **\[ReviewerComments]** | Custom message sent by reviewer | #### Tag usage | Template name | Supported tags | | --------------------- | ----------------------------------------------------------------------------- | | Comment Added | `[UserFullName] [Commentator] [Link]` | | Commentary Mention | `[UserFullName] [Sender] [Link]` | | Commentary Share | `[UserFullName] [Sender] [Message] [Link]` | | Commentary Watch | `[UserFullName] [Link]` | | Workflow Review | `[UserFullName] [StepNumber] [SubmitterComments] [Link]` | | Workflow Cancellation | `[UserFullName] [AdminUserDisplayName] [ApprovalWorkflowName]` | | Workflow Approved | `[UserFullName] [StepNumber] [ReviewerDisplayName] [ReviewerComments] [Link]` | | Workflow Rejected | `[UserFullName] [StepNumber] [ReviewerDisplayName] [ReviewerComments] [Link]` | # Welcome  # Embedding a new extension ## **Embedding commentary in a sheet** Commentary can be embedded into one or multiple sheets across your application. To embed commentary on a sheet, follow these steps: 1. Click on **Edit** sheet button  2\. Select **Custom objects** tab  3\. Drag a Qommentary Insights extension to the sheet  4\. Click on **Done editing** button  5\. Congrats! Your new Qommentary Insights extension has been added.  {% hint style="info" %} Commentary input is disabled in unpublished sheets and will only be enabled once the application or sheet has been published. {% endhint %} # Link charts to commentaries Commentary can be associated to one or multiple visualizations displayed on the same sheet. Once linked, visualizations will be loaded into context when viewing/writing commentary and included in exported PDF reports. If the linked chart has a title, subtitle or footer - it will display when chart is loaded in commentary. You may also disable chart titles by navigating to *Commentary > General* in the Properties Panel and unchecking "Display chart titles". To link visualizations to a commentary, follow these steps: 1. Click on **Edit** button  2\. Click on **Add visualizations** button  3\. Select the visualizations you would like to add  4\. Click on **Add** button  5\. The selected visualizations have now been added  # Updating global config ## Configuring Qommentary Insights The Qommentary Insights Extension contains a main config.js file with the following configurable parameters:  These properties are automatically populated during the installation process; however, they can be manually updated by editing the config.js file found on the root of the extension folder. Alternatively, you can also update the config file with the Dev Hub following these steps: **Updating environment endpoints** 1. Navigate to the Dev 2. Hub Select Extension Editor
3\. Click on Open project and select Qommentary Insight
4\. Edit the config.js file
# Properties
Qommentary extension settings are managed by the Qlik Sense properties panel. Properties allows you define certain aspects of the extension configuration, such as commentary input restrictions, styling and more.
## Commentary mandatory fields
Mandatory fields allow you to define one or more dimensions which must be selected before commentary can be add.
{% hint style="info" %}
This feature is useful if you want to restrict the scope of commentary input down to a specific set of dimensions (e.g. only capture commentary when a Year and Product has been selected).
{% endhint %}
**Adding a mandatory field**
1. Click on **Add fieldset** button
(Compact Mode)
2\. Type some text into the rich-text editor
3\. Click on Save button
4\. **Congrats!** You have saved your first commentary as a draft.
### **Editing a commentary**
Once commentary has been created for a given set of selections, you can edit the commentary given you have the following roles or permissions:
To edit an existing commentary, follow these steps:
1. Click on the commentary screen or click on the 
icon
2\. Update your existing commentary
3\. Click on **Save** button
4\. Your commentary has been successfully updated
### **Submitting for approval**
If the stream, application or sheet where the commentary resides is being managed by an approval workflow, you may submit a commentary for approval given you have the following roles or permissions:
To submit a commentary for approval, follow these steps:
1. **Write** a commentary or **edit** an existing one
2\. Click on **Save** button
3\. Click on **Submit for approval** button
4\. The commentary has been successfully submitted for approval
### **Publishing a commentary**
A commentary can be shared with all other application users, if the commentary status is set to Draft (without an approval workflow) or Approved (with an approval workflow).
Once a commentary is ready to be shared, you may publish the commentary given you have the following roles or permissions:
To publish a commentary, follow these steps:
1. Click on **Publish** button
2\. The commentary has been successfully published
### **Recalling a commentary**
If a commentary which has been published needs to be updated, you will need to recall the commentary given you have the following roles or permissions:
To recall a published commentary, follow these steps:
1. Click on the 
icon
2\. The commentary has been recalled successfully and the status will be reset to Draft
3\. You may now edit the commentary.
**Comparing a draft commentary to the published version**
During the commentary authoring phase, it might be useful to compare a commentary against the published version.
To compare a commentary against the published version, follow these steps:
1. Click on the 
icon to edit a commentary
2\. Click on the 
icon to access full screen view
3\. Click on the 
icon to display the currently published commentary version
4\. The published commentary is now displayed side-by-side with your draft commentary.
### **Viewing commentary info**
1. Hover on top of the 
icon
2\. The commentary info will display the full name and date/time of the last updated commentary
# Searching draft and publish
Often commentaries are saved applying various filters and drilldowns. To browse through all commentaries published in a Qommentary Insights extension, follow these steps:
1. Click on the 
icon
2\. You can now search for a commentary in draft, awaiting approval or published
3\. Click on **View commentary** to retrieve the commentary’s context into view
# Subscribing to notifications
Commentary can be watched to be automatically alerted when a new commentary has been published.
1. Click on the 
icon
2\. The commentary is now being watched and an email notification will be sent when a new commentary is published.
# Sharing commentary
A commentary can be shared to one or multiple users and/or groups. To share a commentary, follow these steps:
1. Click on the 
icon
2\. Click on Add groups or Add users and start typing a name. Optionally write a personal message
3\. Click on Share button
4\. An email notification will be sent to each user and group selected, with a link back into the application and selection context.
# Ad-hoc reporting
When exporting a commentary to PDF format, a document will be instantly generated which will contain the full commentary together with any associated visualizations.
Commentary exporting can be enabled or disabled if desired. To enable or disable commentary exporting please follow these steps:
1\. Edit the sheet and select your Qommentary Insights extension\
2\. Expand *Commentary > General* section in the properties panel\
3\. Click on the *Allow export* switch control to enable or disable commentary export
icon
2\. A commentary report will be generated on the fly
# Discussion comments
Discussion comments, as opposed to commentary, is an effective way to quickly collaborate with business colleagues, ask questions and provide context which ultimately leads to action.
Comments are associated to a specific commentary and data selection in time. This ensures that discussions are always in context and relevant. However, a discussion comment can also be added without the existence of a commentary. This could spark a conversation which might lead to a more detailed commentary for the benefit of other users.
### Comment creation types
There are 2 ways to create comments: Quick and Advanced mode.
When **Quick** mode is activated, users can type and send their comments in a chat-like fashion.
However, activating **Advanced** mode exposes additional controls such as **comment privacy** - where users can lock down comment visibility to specific users or just to themselves like personal notes.
To switch between comment creation modes, please follow these steps:
1. Edit the sheet
2. Select your Qommentary Insights extension
3. Expand the *Discussions > General* section in the Properties Panel
4. You may now select Quick or Advanced mode
icon
2\. Type your comment in the text box
3\. Click on **Send** button
4\. Your comment has been sent successfully
#### **Advanced mode**
If you wish to offer users more control on comment visibility, then Advanced mode should be activated. Focusing on the comment field would launch a popup window with additional privacy control options.
### **Comment privacy**
Comments can have 3 different privacy types:
* Everyone (Public) : Any application user can see the comment
* Specific Users (Limited): Only users specified can see the comment
* Only me (Private): Only the comment owner can see the comment
To set a comment privacy type, please follow these steps:
1. Click on the Discussions icon
icon
3\. Click on Send button
4\. The comment has been successfully sent and users will be notified.
### **Viewing linked visualizations**
Comments that display a 
icon will indicate that it has a linked visualization. To view a linked visualization, follow these steps:
1. Click on the icon
2\. The linked visualization will be loaded successfully
### **Deleting a comment**
To delete a comment, follow these steps:
1. Click on the 
icon
2\. Click on **Delete** button
3\. The comment has been successfully deleted
### **Refreshing comments**
If you need to retrieve new comments which were sent during your active session, you may use the refresh comments functionality. To refresh comments, follow these steps:
1. Click on the 
icon
2\. New comments (if available) will be displayed in the comments panel
# Storytelling presentations
**Embedding commentary in stories**
Qommentary can be embedded in Qlik Sense stories, to take advantage of its powerful storytelling capabilities and bring context-aware commentary to presentations.
To embed commentary in stories, follow these steps:
1. Right-click on the commentary you would like to embed
2\. Click on snapshot icon
3\. Give your snapshot a description and click on Save button
4\. Navigate to the story you would like to embed the commentary into
5\. Open the Snapshot Library
6\. Drag the commentary snapshot to the canvas
7\. Your commentary snapshot has been embedded successfully
# Exporting in Qlik Sense
Qommentary is compatible with Qlik Sense native printing functionality. Any commentary embedded in an application will be included when exporting a sheet to PDF or exporting an object to image or PDF.
To export a sheet to PDF, follow these steps:
1. Navigate to a sheet that has embedded commentary
2\. Open the menu and select Download sheet as PDF
3\. Choose your preferred export settings and click on Export
4\. The sheet has been exported to PDF successfully
# Welcome
# Embedding a new extension
The Qommentary Table Extension allows you to display tabular data in a straight table format and allow multiple users to collaborate by writing comments on each row.
To add your first Qommentary Table Extension to an application, follow these steps:
1\. Open an application of your choice \
2\. Click on Edit sheet button
3\. Select the Custom objects tab
4\. Drag a Qommentary Table extension to the sheet
5\. Select some Dimensions and Measures
6\. A new Qommentary Table extension has been added! Commenting
{% hint style="warning" %}
Commenting is only enabled in published applications.
{% endhint %}
# Updating global config
The Qommentary Table Extension communicates with the Qommentary Engine API which can be hosted on the same server as Qlik Sense, or on a separate server.
To update the Qommentary Engine API endpoint, follow these steps:
1\. Navigate to the Dev Hub \
2\. Select Extension Editor \
3\. Click on Open Project and select the “Qom Table” extension
Now you can embed the Qommentary Table Extension in multiple applications across your Qlik Sense environment and manage the config parameters from a single location.
# Properties
**Dimensions**\
To add a dimension to your table, click on Add dimension and select a dimension from the list.
* Field: Please see *Qlik Sense Table properties* documentation.
* Label: Please see *Qlik Sense Table properties* documentation.
* Dimension: Only displayed for master items. Please see *Qlik Sense Table properties* documentation.
* Include null values: Please see *Qlik Sense Table properties* documentation.
* Limitation: Please see *Qlik Sense Table properties* documentation.
* Column width: Drag the slider handle horizontally to adjust the column width in pixels
* Custom column width: Enter a number to set a custom width for the column. You can also use an expression to set the number. Click ***fx*** to open the expression editor.
* Allow sorting: Enable or disable sorting on individual columns. You may disable sorting for all dimensions globally under Table > Allow sorting.
* Commentary details view: Display column in row-detail table shown when a comment for a specific row is selected.
**Measures**
To add a measure to your table, click on Add measure to open a list of available measures. Select the measure that you want to use. If you select a field, you are automatically presented with some common aggregation functions that you can choose between for the measure.
* Measure: Please see *Qlik Sense Table properties* documentation.
* Expression: Please see *Qlik Sense Table properties* documentation.
* Label: Please see *Qlik Sense Table properties* documentation.
* Number formatting: Please see *Qlik Sense Table properties* documentation.
* Column width: Drag the slider handle horizontally to adjust the column width in pixels.
* Custom column width: Enter a number to set a custom width for the column. You can also use an expression to set the number. Click *fx* to open the expression editor.
* Commentary details view: Display column in row-detail table shown when a comment for a specific row is selected.
**Sorting**\
Please see *Qlik Sense Table properties* documentation.
**Table**
* Table layout: Determines how the table will manage column widths for the overall table layout. The following formats are available:\
1\. Horizontal scrollbar: Widths are fixed for each column and a horizontal scrollbar is enabled if the total number of columns exceed the available table width.\
2\. Fit in view: Column widths are auto-calculated and distributed equally amongst the available table width.
* Allow sorting: Enable or disable sorting in all dimension columns.
**Comments**
Table commenting is a powerful feature which allows application users to share insights and feedback on individual rows, based on the current selection state and their permission level.
* Display last comment: If enabled, it will display the last comment entered on the Comments column cells. Disabling this feature would only display the total number of comments per row.
* Column width: Drag the slider handle horizontally to adjust the column width in pixels.
* Custom column width: Enter a number to set a custom width for the column. You can also use an expression to set the number. Click fx to open the expression editor.
* Colors: Customizes cell colors for the Comments column, overriding the default theme colors. The following options are available:\
**1.** Auto: Default theme colors are applied.\
**2**. Custom: Choose custom background and text colors for the Comments column.
* Enable profile photos: If enabled, each individual comment will display user profile photos (if available).\
**1**. Content Library name: Choose from a list of Qlik Sense content library names where images are stored. You will need to previously upload pictures to a content library folder.\
Images must be in JPG format and file must follow a specific naming convention, where the file name represents the Qlik Sense user ID, e.g. jsmith.jpg\
**2**. Profile photo shape: Customize the way that profile photos are displayed by choosing amongst 3 different user profile photo shapes.
**Appearance**
* General: Please see *Qlik Sense Table properties* documentation.
* Alternate states: Please see *Qlik Sense Table properties* documentation.
* Header o Background color: \
**1.** Pick a custom color for the table header background \
**2**. Font color: Pick a custom color for the table header font text \
**3**. Horizontal alignment: Choose if the header column title should be left, center or right aligned.
* Rows: Enable if you would like the table cell text to wrap into multiple lines. Unchecking this option would display text in a single line and hide any overflowing content.
* Totals\
**1**. Display totals row: Show or hide the Totals row\
2\. Label: Add a custom label or click the ***fx*** icon to open the Expressions editor\
3\. Background color: Pick a custom color for the table Totals background\
4\. Font color: Pick a custom color for the table Totals font text
**Known limitations**
* There’s a current limitation when converting any object into a Qommentary Table extension which causes invalid table rendering when adding or removing columns.
* Table does not render properly in full screen.
* Approval workflows cannot be applied to row comments. This feature will be available in future releases.
# Appearance
### Columns
#### Text and Background cell color
To customize each cell text and background color, please follow these steps:
1. Edit the sheet
2. Select the Qommentary Table extension
3. Expand the dimension or measure properties
4. Type in a text/background color or derive the value from an expression
icon where you wish to leave a comment
2\. If you are the first one to leave a comment, click on the “Add a comment” button
3\. Write your comment and click on the “Add” button
4\. Your new comment has been added!
### **Editing comments**
Once a comment has been added, either by you or someone else, you may choose to update it.
To edit a comment, you must be either:
* a Root Admin
* an Editor Admin or
* have Update Commentary permissions on the resource
If you wish to edit a comment, please follow these steps:
1. Click on the 
icon
2. Update your comment
3\. Click on the Save button\
4\. Your comment has been updated!
### **Deleting comments**
To delete a comment, you must be either:
* a Root Admin
* an Editor Admin or
* have Delete Commentary permissions on the resource
1. Click on the 
icon
2. Click on the Delete button
3\. Your comment has been deleted!
### **Searching comments**
Once all comments are displayed for a specific row, you may search for a specific comment by typing any word found on the message or by author name.
To search in comments, follow these steps:
1. Click in the search field
2\. Start typing a search term\
3\. The list of comments will be filtered by the searched term
# Embedding a new extension
The *Qommentary Pivot Table* allows you to calculate, summarize and analyse data to see comparisons, patterns and trends in the data.
\\
\
With the *Qommentary Pivot Table*, you can pivot dimensions interchangeably between rows and columns with an intuitive drag and drop motion, expand dimensions to drill down further and customize in many different ways.
To add your first *Qommentary Pivot Table* extension to an application, follow these steps:
1. Open the application of your choice
2. Click on **Edit sheet** button
3\. Select the **Custom objects** tab
4\. Expand **Qommentary Library** and drag a **Qom Pivot Table** extension to the sheet
5\. Select your desired Dimensions and Measures
A new *Qommentary Pivot Table* extension has been added!
# Updating API endpoints
The *Qommentary Pivot Table* contains a main config.json file which holds information relevant to your environment where Qommentary is hosted - such as the Qommentary Engine API endpoint.
Sometimes, there's network changes on server where Qommentary is hosted which could impact extensions, such as:
* FQDN changes (e.g. hosting Qommentary on a new server)
* Protocol changes (e.g. moving from http to https)
* Port changes (e.g. changing from default 5004 to a new port number)
To keep the Qommentary endpoints up to date, please follow these steps:
1. Navigate to the **Dev Hub**
2. Select the **Qom Pivot Table** extension
3. Update the affected endpoints
Now you can embed the *Qommentary Pivot Table* extension in multiple applications across your Qlik Sense environment and manage configuration from a single location.
# Adding dimensions
When you drag and drop a *Qommentary Pivot Table* extension to your sheet, you will be prompted to select Dimensions.
Adding dimensions works in the same fashion as like Qlik Sense charts. To add a dimension to your table, click on **Add dimension** and select a dimension from the list.
Add as many dimensions you need to see in the table and expand dimension to view the properties, When you use more than one dimension, they are automatically nested together and displays in the same order as defined for left and top views. If table has 2 dimensions selected, expanding the first dimension displays its next dimension values.
### Dimension position
The *Qommentary Pivot Table* extension allows dimensions to be displayed as rows or columns, thus enabling data to be sliced and diced in different ways.
To change the dimensions position, follow these steps:
1\. Edit your sheet
2\. Click on the *Qommentary Pivot Table* extension
3\. Expand dimension properties
4\. Scroll down to the **Position** property\ 
5\. Select **Left** to display dimension data as rows
6\. Select **Top** to display dimension data as columns
During table analysis, users can pivot dimensions between rows and columns by the use of drag and drop actions.
### Enabling totals
Totals can be enabled to aggregate measure values on rows and columns.
To enable Totals for dimensions, follow these steps:
1\. Click on **Edit sheet** button
2\. Expand the dimension properties
3\. Scroll down to the **Show totals** property and turn on the switch
You will now see Totals for the selected dimension
### Customizing totals label
The Totals label can be easily customized to add further context to your data. Expressions are allowed.
To customize Totals label, follow these steps:
1\. Click on **Edit sheet** button
2\. Expand the dimension properties
3\. Scroll down to the **Totals label** property and enter desired text
The selected dimension will now display a customized Totals label:
# Adding measures
When you drag and drop a *Qommentary Pivot Table* extension to your sheet, you will be prompted to select Measures.
Adding measures works in the same fashion as like Qlik Sense charts. To add a measure to your table, click on **Add measure** to open a list of available measures.
Measures will be displayed as columns and recalculated when data changes
# Adding color to cells
Color is a powerful visual indicator which can help identify change or trends over time. The *Qommentary Pivot Table* allows you to add custom background and text colour to dimensions and measures.
To add color to your cells, follow these steps:
1\. Click on **Edit sheet** button
2\. Expand the dimension/measure properties
3\. Scroll down to the **Background color expression** property and enter a value or expression
### Using a composite dimension
When a single dimension cannot produce unique records, then a composite dimension must be created.
Example:\
{% hint style="info" %}
You may hide the column if you do not wish to display it in your table.
{% endhint %}
# Adding data to your table
When you drag and drop a *Qommentary Writeback* extension to your sheet, you will be prompted to select Dimensions and Measures.
Adding dimensions and measures works in the same fashion as native Qlik Sense charts.
{% hint style="warning" %}
A minimum of **one (1) dimension** is required for the extension to be initialized.
{% endhint %}
Additionally, the following *Qommentary Writeback* properties are available:
### Dimensions
| Property | Description | Default |
| --------------------- | -------------------------------------------------------------- | ------- |
| Primary key dimension | Enable if dimension will be used as a primary key | `false` |
| Hide column | If ticked, dimension will not be displayed in table | `false` |
| Column width | Custom column width in pixels | `125px` |
| Allow sorting | Allows dimension to be sorted in ascending or descending order | `true` |
### Measures
| Property | Description | Default |
| ------------- | -------------------------------------------------------------- | ------- |
| Hide column | If ticked, dimension will not be displayed in table | `false` |
| Column width | Custom column width in pixels | `125px` |
| Allow sorting | Allows dimension to be sorted in ascending or descending order | `true` |
---
[Next Page](https://knowledgebase.qommentary.com/llms-full.txt/1)