> For the complete documentation index, see [llms.txt](https://knowledgebase.qommentary.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.qommentary.com/qommentary-insights/configuring-extension-properties.md).

# 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&#x20;

<div align="center"><img src="/files/-MbLexDE-NlETjZU-3u2" alt=""></div>

&#x20;2\. Click on **Add field** button&#x20;

<div align="center"><img src="/files/-MbLf60Tqc5Xsm3rfXrR" alt=""></div>

3\. Select a mandatory field you would like the user to select before entering commentary

![](/files/-MbLfMI2jgRrSOw0Gl9P)

4\. Repeat Step 2 and add more fields as required. These fields will have an ‘AND’ relationship, meaning that all fields contained within a group would need to be selected before commentary can be entered.

5\. Repeat Step 1 and add more fieldsets as required. These fieldsets will have an ‘OR’ relationship, meaning that commentary entry will be enabled if any fieldset passes the test.

**Allowing additional selections on mandatory fields**

<div align="left"><img src="/files/-MbLfnmUG3rMPb65N2u9" alt=""></div>

If enabled, commentary entry will be allowed even if additional selections have been made which do not match the mandatory fields. **Default***:* True

**Additional Settings**

<div align="left"><img src="/files/-MbLhJip3yFSICEHItEd" alt=""></div>

If enabled, Qlik Sense hidden fields will be excluded from the selection context

<div align="left"><img src="/files/-MbLi1T7bbNplh6gzkmm" alt=""></div>

If enabled, commentary entry will not be associated to the application selections. **Default***:* False

<div align="left"><img src="/files/-MbLiMRWJ2PuCSw6gZay" alt=""></div>

If enabled, commentary entry will be allowed even if no selections were made in the application. **Default:** True

## Discussions Panel

**General**

<div align="left"><img src="/files/-MbLk1XN--LNe5Nl9JbK" alt=""></div>

Enabling discussions will allow users to engage in a chat-like threaded discussion on any given commentary context.

**Comments**

<div align="left"><img src="/files/-MbLli4NyuOmffEHH34S" alt=""></div>

Enable user profile photos by uploading pictures in JPG format to any given content library of your choice.

## Presentation

Commentary can be visualized in 2 distinctive formats:

<div align="left"><img src="/files/-MbZD-uRdZT_Tr5Ixfv8" alt=""></div>

**Textbox mode**\
A rich-text box which allows commentary to be always visible to the application user.

**Textbox font size:** Allows a custom Font to the text to be applied

<div align="left"><img src="/files/-MbZEfhmMu1bllyuP2cp" alt=""></div>

**Textbox background image:** Allows a custom image to the textbox as background to be applied

**Apply image as a pattern:** Selecting this allows the image to align full textbox as background. **Default:** Selected

<div align="left"><img src="/files/-MbZGUIm09FcngEhX1JU" alt=""></div>

Unselecting **Apply image as a pattern**, displays options to select for image alignment

<div align="left"><img src="/files/-MbZ7GO_V3F407QBReHc" alt=""></div>

**Icon mode**\
An icon with a popup window which enables commentary to be embedded into multiple sheet locations without compromising space.

**Icon size:** Changes the size of the icon

**Icon color:** Changes the color of the commentary icon

**Icon font:** Allows a custom Font Awesome icon to be applied

<div align="left"><img src="/files/-MbZHrGl6l1FAFKenv8T" alt=""></div>

Displays the action and status bars in the commentary text box always

<div align="left"><img src="/files/-MbZIOFLIEdj_AwkbsW7" alt=""></div>

Hides the action and status bars from the commentary text box and will only show them on hover. This mode maximizes commentary real estate and offers a cleaner and less cluttered look and feel.

## Color

<div align="left"><img src="/files/-MbZJI-zZ3EHjxeW_wVw" alt=""></div>

**Textbox background color:** Changes the color of the commentary textbox background color.

**Textbox font color:** Changes the color of the commentary textbox font.

**Toolbar background color:** Changes the color of the commentary toolbar background color.

**Toolbar text color:** Changes the color of the commentary toolbar text color.

**Publishing an application with Qommentary**

Once Qommentary has been setup in an application, it needs to be published to a stream to enable user interaction. \
To publish an application to a stream, just follow the instructions found on the [Qlik Help](https://help.qlik.com/en-US/sense/November2018/Subsystems/Hub/Content/Sense_Hub/Publishing/publish-app.htm) site.

**Registering an application with Qommentary**

New Qommentary Insights extensions that have been added to an application for the first time will be registered with the Qommentary environment once the extension has loaded in a published application for the first time. This process will ensure that the newly registered extension is visible and appears when navigating the Resource Directory Tree in the Qommentary Manager.

{% hint style="info" %}
The registration process is only required if you intend to assign an approval workflow or security permissions at a commentary level.
{% endhint %}

To register a new Qommentary Insights extension follow these steps:

1. Add a Qommentary Insights extension to an application&#x20;

![](/files/-MbsUU7MOvfMTfzppGh_)

&#x20;   2\. Publish the application to a stream

![](/files/-MbcyOGSqOyKi_T7L1QC)

3\. Navigate to the published application which contains the recently added   Qommentary Insights Extension

![](/files/-MbsVAimi07pnZDfbdJ9)

4\. That’s it! The Qommentary Insights Extension is now registered and exposed in the Qommentary Manager.

To test the new extension has been registered follow these steps:&#x20;

1. Navigate to the Qommentary Manager
2. Choose Approval workflows (also works with Security)&#x20;
3. Create a new approval workflow or edit an existing one
4. Use the Resource Directory Tree to locate the sheet you recently accessed

![](/files/-MbsW9BNEjDSxkCOVjJr)

5\. The registered Qommentary Insights Extension will be displayed in the Resource Directory Tree

![](/files/-MbsVwW86le7lZwGPXiQ)

&#x20;**Updating a Qommentary Insights Extension title**

By default, registered Qommentary Insights extension titles are displayed as “\[Commentary]”. To give your security and workflow admins more context on the commentary being selected, you can update the title in the properties panel to something a bit more meaningful.

To update the title, follow these steps:

1. Edit the application and select the Qommentary Insights extension you would like to update

![](/files/-MbsWZ_QhTxDXlHh0B8r)

2\. Expand Appearance > General and enter a title

![](/files/-MbsWvU28fck35oPb-DC)

3\. Click on Done\
4\. Re-publish the application to a stream

![](/files/-Mbd8hTLgp_SSn3kz2kh)

5\. Refresh the published application to pick up the latest changes

![](/files/-MbsX8os4DuTmb1F0dJi)

6\. Return to the Qommentary Manager and click on the node icon\
7\. The Qommentary Insights extension title has been updated successfully.

![](/files/-MbsXhPr8UG_QPDdW7Vr)
