# 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbKtgoCsy8B5-pXv9It%2F-MbLexDE-NlETjZU-3u2%2Fimage.png?alt=media&#x26;token=360de386-af4f-428d-aff9-50626bb3b87f" alt=""></div>

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

<div align="center"><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbKtgoCsy8B5-pXv9It%2F-MbLf60Tqc5Xsm3rfXrR%2Fimage.png?alt=media&#x26;token=9c20ecc6-f1ab-44e3-99cc-a6b90e272699" alt=""></div>

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbKtgoCsy8B5-pXv9It%2F-MbLfMI2jgRrSOw0Gl9P%2Fimage.png?alt=media\&token=aefb5c53-9a2f-493b-9fa0-b797a4a952af)

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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbKtgoCsy8B5-pXv9It%2F-MbLfnmUG3rMPb65N2u9%2Fimage.png?alt=media&#x26;token=14ad7cf8-8575-4576-ac05-f31650a9c4f2" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbKtgoCsy8B5-pXv9It%2F-MbLhJip3yFSICEHItEd%2Fimage.png?alt=media&#x26;token=8ea57d35-4920-44a0-9cb6-68dfb5349554" alt=""></div>

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

<div align="left"><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbLhRuN_i7j9WzXthGq%2F-MbLi1T7bbNplh6gzkmm%2Fimage.png?alt=media&#x26;token=b5ee85cf-2a34-495a-8b6a-56ca9ae0fde8" alt=""></div>

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

<div align="left"><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbLhRuN_i7j9WzXthGq%2F-MbLiMRWJ2PuCSw6gZay%2Fimage.png?alt=media&#x26;token=a5071eba-a390-47e6-85cb-d01a3c0ecf31" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbLhRuN_i7j9WzXthGq%2F-MbLk1XN--LNe5Nl9JbK%2Fimage.png?alt=media&#x26;token=fd56b9f5-09e0-4656-a35e-f84af3959d4c" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbLhRuN_i7j9WzXthGq%2F-MbLli4NyuOmffEHH34S%2Fimage.png?alt=media&#x26;token=e0cac9aa-6239-4429-8341-bc3a43bbbd7e" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbZ6gTrbMXt-FRcAYW1%2F-MbZD-uRdZT_Tr5Ixfv8%2Fimage.png?alt=media&#x26;token=740f9265-fe40-4700-94a0-776d7718e170" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbZ6gTrbMXt-FRcAYW1%2F-MbZEfhmMu1bllyuP2cp%2Fimage.png?alt=media&#x26;token=025a0eff-c9bb-4b3b-be03-0ef216a5d4d1" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbZ6gTrbMXt-FRcAYW1%2F-MbZGUIm09FcngEhX1JU%2Fimage.png?alt=media&#x26;token=a03a255f-9959-4ba6-b588-5db994f720da" alt=""></div>

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

<div align="left"><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbZ6gTrbMXt-FRcAYW1%2F-MbZ7GO_V3F407QBReHc%2Fimage.png?alt=media&#x26;token=e114f7b3-34c6-4252-81b9-dc09fdfbc7f4" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbZ6gTrbMXt-FRcAYW1%2F-MbZHrGl6l1FAFKenv8T%2Fimage.png?alt=media&#x26;token=e34f7c7d-d51b-4571-ba90-ec6e8ea14248" alt=""></div>

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

<div align="left"><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbZ6gTrbMXt-FRcAYW1%2F-MbZIOFLIEdj_AwkbsW7%2Fimage.png?alt=media&#x26;token=8c0b8b7c-29ef-4dac-ade2-c144aa41bf97" 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="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbZ6gTrbMXt-FRcAYW1%2F-MbZJI-zZ3EHjxeW_wVw%2Fimage.png?alt=media&#x26;token=83563e95-ac61-46d3-b166-6f037187dff9" 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;

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsUU7MOvfMTfzppGh_%2Fimage.png?alt=media\&token=133f9a62-3a04-46bc-b971-5851aabde643)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbcrFA7ZICe3vT3n4Id%2F-MbcyOGSqOyKi_T7L1QC%2Fimage.png?alt=media\&token=8f7e969f-1a4a-402b-9fd6-7dc1acc8b405)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsVAimi07pnZDfbdJ9%2Fimage.png?alt=media\&token=cd349bc8-9ab6-46bf-b280-df7895428d61)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsW9BNEjDSxkCOVjJr%2Fimage.png?alt=media\&token=5dfd7dbc-9d7b-4121-9753-080b3a670de1)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsVwW86le7lZwGPXiQ%2Fimage.png?alt=media\&token=56fb3e2a-e673-4c48-a48e-c79db62cd6c3)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsWZ_QhTxDXlHh0B8r%2Fimage.png?alt=media\&token=9686a94e-0e60-49f6-817b-c3b7a35b5eaf)

2\. Expand Appearance > General and enter a title

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsWvU28fck35oPb-DC%2Fimage.png?alt=media\&token=da18cd86-da93-4dd4-984b-e53cdc974393)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbcrFA7ZICe3vT3n4Id%2F-Mbd8hTLgp_SSn3kz2kh%2Fimage.png?alt=media\&token=451b919d-254b-4549-8776-0b6aa02b727d)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsX8os4DuTmb1F0dJi%2Fimage.png?alt=media\&token=19d6ea25-41b4-4a60-a6f4-3e3168037367)

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

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsJ1WmLeoWs5kf_7qj%2F-MbsXhPr8UG_QPDdW7Vr%2Fimage.png?alt=media\&token=b7307738-58c6-469e-b21e-0a0836645ff2)
