# Working with commentary

A Qommentary Insights extension can be embedded in two (2) different ways: **Default** view and **Fullscreen** view.

**Default View**

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-Mbi4Ql9TcStMN0QCkgp%2Fimage.png?alt=media\&token=dcae1c20-d469-4d3d-b9f0-0e9fc5db9f8b)

1. Commentary message: Displays commentary text entered by the user
2. Commentary Status: Displays the current commentary status.&#x20;
3. Commentary explorer: Displays a list of draft, awaiting approval and published messages for the current extension.&#x20;
4. Discussions: Opens the Discussions panel to enable threaded comments amongst teams&#x20;
5. Watch: Subscribes a user to a Qommentary Insights extension to receive updates when new commentary has been published.&#x20;
6. Share: Launches a popup window and allows commentary to be shared to one or many user/s or group/s.&#x20;
7. Export: Generates a PDF report of the current commentary including any associated visualizations.&#x20;
8. Edit/Recall: Depending on the commentary status, a user is able to Edit a commentary on Draft status or Recall a commentary on Published status.&#x20;
9. Fullscreen view: Expands the commentary full screen and switches to Fullscreen View.&#x20;
10. Commentary details: Displays additional commentary-related information, such as created/published date/time and owner’s full name.

**Fullscreen View**

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdL7Y_zbi71zeDml8J%2Fimage.png?alt=media\&token=c2381398-771e-4809-8356-5d76284231f5)

1. Commentary visualization: Loads any visualization which has been associated to the commentary during the development phase.&#x20;
2. Visualization panel controls: Allows you to expand or collapse the visualization panel.&#x20;
3. Comments panel: Allows you to expand or collapse the comments panel.&#x20;
4. Close fullscreen: Closes the Fullscreen View and returns to Default View.&#x20;
5. Refresh comments: Updates the current list with latest comments.&#x20;
6. Send comment: Sends a new comment.&#x20;
7. Link visualization: Associates the current visualization to the new comment.&#x20;
8. Input comment field: Allows you to type a new comment in the text field box and mention users.&#x20;
9. Action button: Depending on the commentary status, it displays various commentary-related action buttons.

### **Commentary display modes**

Qommentary Insights can be embedded in an application in two (2) different ways: **Full** and **Compact**.

**Full Mode**

Full mode displays a rich-text editor embedded on the sheet for added context and visibility.

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-Mbi6fttKwQ_GOvYVnlQ%2Fimage.png?alt=media\&token=564400fe-bb02-4b0a-92fb-f175548c7477)

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdMQrQXI7IXWwQp4EJ%2Fimage.png?alt=media\&token=8dcfcb8f-94d1-489f-afa4-a30c25b14e1d)

**Compact Mode**

Compact mode displays an icon on the sheet, ideal for visualization-intensive applications where real estate is limited. This mode allows multiple Qommentary Insights extensions to be embedded in a single sheet without compromising dashboard design.

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiBokpqgyQyaoSvH3I%2Fimage.png?alt=media\&token=4e1c0cf0-8ac5-48f0-a10f-14a6865ea12c)

The Compact mode icon appearance can be customized in a variety of ways:

**Changing icon color**

<div align="left"><figure><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M43RhGzV8Plu0tfknia-1306060056%2Fuploads%2F8sMmMM2gJfeJnVKO2HlH%2Fimage.png?alt=media&#x26;token=b49c13d5-c0dc-4c4f-9bae-25b597b4156e" alt="" width="150"><figcaption></figcaption></figure></div>

1. Edit the sheet
2. Select your Qommentary Insights extension
3. In the Properties Panel, expand *Appearance > Presentation*
4. Under the **Icon color** property choose an color

**Changing icon background color**

<div align="left"><figure><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M43RhGzV8Plu0tfknia-1306060056%2Fuploads%2FVQpLDUKrG11YMFasMaBy%2Fimage.png?alt=media&#x26;token=6dcd5d16-4fbb-42c3-8347-930219506d56" alt="" width="151"><figcaption></figcaption></figure></div>

1. Edit the sheet
2. Select your Qommentary Insights extension
3. In the Properties Panel, expand *Appearance > Presentation*
4. Under the **Icon background color** property choose a color

**Changing icon shape**

<div align="left"><figure><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M43RhGzV8Plu0tfknia-1306060056%2Fuploads%2FvFBbDYRXzMtqPWHc09Km%2Fimage.png?alt=media&#x26;token=9935d72b-00f0-4889-af75-8a9dbeb672c3" alt="" width="148"><figcaption></figcaption></figure></div>

1. Edit the sheet
2. Select your Qommentary Insights extension
3. In the Properties Panel, expand *Appearance > Presentation*
4. Under the **Icon background shape** property choose a shape

### **Commentary Status**

A commentary can progress through five (5) different statuses along its lifecycle:

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdNFtPG_-JE1R4qTib%2Fimage.png?alt=media\&token=d460dea4-22f5-4d4c-a609-a057d1355b51)

1. Draft: Commentary is in draft mode and not visible to the application users&#x20;
2. Awaiting Approval: Commentary has been submitted for approval and it’s waiting for approval workflow to be completed before publishing.&#x20;
3. Recalled: User wishes to edit a commentary which has been published, or edit a rejected commentary.&#x20;
4. Approved/Rejected: Commentary has been approved and is ready to be published or has been rejected and must be recalled before re-submitting for approval.
5. Published: Commentary has been published and is not visible to all application users.

### **Rich text formatting**

Qommentary Insights allows commentary to be formatted just like your favourite text editor. There are two (2) types of text formats available: **plain text** and **rich text**.

To select a text format option, please follow these steps:

1\. Edit the sheet and select your Qommentary Insights extension

2\. Expand *Commentary > Text editor* section in the properties panel

<div align="left"><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MfVe3TvOa6WJ0gC-LNm%2F-MfVfMn5UfGNIjuhzoMm%2Fimage.png?alt=media&#x26;token=5e4185d2-dedb-43fd-8d40-ac13de1df4ed" alt=""></div>

3\. Choose a **text format** option

{% hint style="warning" %}
If switch from **rich text** to **plain text** and edit a commentary which was previously saved with rich-text formatting, the commentary will be converted to plain text when you save.
{% endhint %}

When **rich text** is selected, you can control which formatting tools are displayed in the editor's toolbar:

| Tool            | Description                                                                |
| --------------- | -------------------------------------------------------------------------- |
| Text formatting | Allows text to be formatted with bold, italic or underline                 |
| Text color      | Allows text background and font colors to be customized                    |
| List            | Allows creation of bullet or number lists                                  |
| Text alignment  | Allows text to be horizontally aligned to left, center, right or justified |
| Link            | Allows text to link to other sheets, applications or external pages.       |

Check or uncheck each option in the properties to enable or disable formatting tools as desired.

To apply rich text formatting to a commentary, please follow these steps:

1. Write a commentary or edit an existing one

<div align="center"><img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdPPT6eGJkqzpiFxId%2Fimage.png?alt=media&#x26;token=d07e74c8-3476-412c-87eb-c59bda3d5253" alt=""></div>

2\. Format your commentary using the rich-text toolbar

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdPYMC2p1i6PBooDSn%2Fimage.png?alt=media\&token=271b8b74-8fa4-4371-929c-fe3c7b826ca9)

3\. Click on the **Save** button

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdPgW9EXpMdIvn2wv0%2Fimage.png?alt=media\&token=359fdbd6-893d-4db8-a266-ec0628515294)

4\. Your commentary has been successfully formatted

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiFMzf6O6aI6TyXbs5%2Fimage.png?alt=media\&token=56f2742b-dd26-4710-9e98-886ea9d1963d)

Enabling

### Creating a commentary

You may begin writing commentary given you have the following roles or permissions:

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiDo-igIcCKJ22BAEQ%2Fimage.png?alt=media\&token=99e2cdbc-9c46-4f7e-b01d-4cb53dc051cf)

To write a commentary, follow these steps:

1. Click on Write a commentary button (Full Mode) or click on the icon <img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdOZ937rEXmL04bhMu%2Fimage.png?alt=media&#x26;token=c376e4b2-d06f-4683-b7d5-0ff41fef7b5c" alt="" data-size="line"> (Compact Mode)

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiEPdrv33qrLtl2s1t%2Fimage.png?alt=media\&token=4549c27d-cd9d-4bc8-8bdb-53ef3b8b3d87)

2\. Type some text into the rich-text editor

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdP0LpW6x8yaOjnEZ4%2Fimage.png?alt=media\&token=8fdda170-908a-4882-890c-a01b781b7df3)

3\. Click on Save button

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdP4va6MvmFHKsa9Sp%2Fimage.png?alt=media\&token=391cf51a-ef3d-433e-810b-9723f2793ca9)

4\. **Congrats!** You have saved your first commentary as a draft.

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiEdMdFC3BOdq0K7nj%2Fimage.png?alt=media\&token=ed5aab06-90ed-43fd-8742-72f7b797e8c2)

### **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:

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdQBQMcuAMC6O9E0xM%2Fimage.png?alt=media\&token=0721378b-45a9-4414-b1fb-327a492043d9)

To edit an existing commentary, follow these steps:

1. Click on the commentary screen or click on the <img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdQN7l3LzxwyVEh6fU%2Fimage.png?alt=media&#x26;token=b1398282-ce41-4fe0-86b2-20a13fdb4685" alt="" data-size="line"> icon

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiFmgBNKQm7m0H8Kc8%2Fimage.png?alt=media\&token=76b4a5a3-8035-4ba5-ac45-1b5c9049f9af)

2\. Update your existing commentary

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiGJF64D9ofaNgbyZA%2Fimage.png?alt=media\&token=1e5bcb63-8abe-43d9-add8-c6bbe05ef1f6)

3\. Click on **Save** button&#x20;

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiGOnSq6k_07V4r3Qe%2Fimage.png?alt=media\&token=a2bc2cd5-f914-4dd1-ad4a-11e7fc609738)

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:

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdRHC96Sn7X2vNbc8K%2Fimage.png?alt=media\&token=d2f000bb-a08d-4dc4-8dca-5e85596e7023)

To submit a commentary for approval, follow these steps:

1. **Write** a commentary or **edit** an existing one

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiGY1gQkj_l2GD9S1U%2Fimage.png?alt=media\&token=d373360b-0d22-43b6-844f-c09b25963105)

2\. Click on **Save** button

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiGoTupI_uqsV-DKQd%2Fimage.png?alt=media\&token=74de79fe-657d-4fd7-ba0a-e4dde8d361ef)

3\. Click on **Submit for approval** button

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiHRxz0xemSYba5pU4%2Fimage.png?alt=media\&token=55c28fc3-7bbd-4803-bff2-650c9bba043b)

4\. The commentary has been successfully submitted for approval

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiHmp2ZYCxjYIk6ZNg%2Fimage.png?alt=media\&token=ee617652-4d1a-4187-8fc9-48fd811eae96)

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

Once a commentary is ready to be shared, you may publish the commentary given you have the following roles or permissions:

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdS48ScMfdEjr1HQI8%2Fimage.png?alt=media\&token=8ab86c9d-0d42-4cea-b8a6-a6eb805a37af)

To publish a commentary, follow these steps:

1. Click on **Publish** button

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiI9vgpTMr_1COdnia%2Fimage.png?alt=media\&token=b6968a2a-04f8-4f74-9b28-55cbf21cf8b1)

2\. The commentary has been successfully published

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiIIwEZZLOqL--dK43%2Fimage.png?alt=media\&token=931eca74-1c61-4ba7-9c11-8f0598ff3850)

### **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:

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdSZUjEP15-J5l6mS4%2Fimage.png?alt=media\&token=d5e8fb1f-77b4-4ab4-abed-13554cbf8cf4)

To recall a published commentary, follow these steps:

1. Click on the <img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdDT46zj7OlI90zTeD%2F-MbdSzd-Jb01-8JagBB3%2Fimage.png?alt=media&#x26;token=9b735eba-63e3-4bd0-981b-37273a2e2d50" alt="" data-size="line"> icon

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiIN8kbRG20G6UIiuQ%2Fimage.png?alt=media\&token=f9b16784-bf76-42da-a6b4-f36265845a57)

2\. The commentary has been recalled successfully and the status will be reset to Draft

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiIWqzqn23LZnhPFQc%2Fimage.png?alt=media\&token=813643e0-23a8-4600-bf39-43a9976a9a72)

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 <img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbdTH6KHNoQbPEQh4KF%2F-Mbe_2hyNxtCh8AFyFK-%2Fimage.png?alt=media&#x26;token=354edeb9-401b-478d-a778-007787c6f552" alt="" data-size="line"> icon to edit a commentary

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiIer0rB5RGm1IfK4V%2Fimage.png?alt=media\&token=9471c3c7-f64f-4815-9997-68c45fa1c760)

2\. Click on the <img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbedfk5-pmP4Iqd1SmH%2F-MbelCB7E4lqjOVYUBID%2Fimage.png?alt=media&#x26;token=194cf08c-35e8-46e6-8ea4-94282b305522" alt="" data-size="line"> icon to access full screen view

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiIuxyQNTynmtO20gJ%2Fimage.png?alt=media\&token=18bf49f1-c24c-4169-aa76-c1f3dfd4f66e)

3\. Click on the <img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbedfk5-pmP4Iqd1SmH%2F-MbenjmncN493a7iHUF1%2Fimage.png?alt=media&#x26;token=ad796381-d358-4b28-a5ba-a4aa586436bc" alt="" data-size="line"> icon to display the currently published commentary version

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiJH6Vv0yXyYIORNiM%2Fimage.png?alt=media\&token=7d3f172b-b6dd-4915-8df8-2b72efe031a0)

4\. The published commentary is now displayed side-by-side with your draft commentary.

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbi2NaEV64xzEeq6DTi%2F-MbiJQhluvMpb1v5kR9I%2Fimage.png?alt=media\&token=90accd64-de3a-4a6d-9851-fad3ea02275f)

### **Viewing commentary info**

1. Hover on top of the <img src="https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-Mbedfk5-pmP4Iqd1SmH%2F-MbeozFFLOHgEUwS2x03%2Fimage.png?alt=media&#x26;token=e2b9702c-48cb-4046-81c7-84f5618c87be" alt="" data-size="line"> icon

![](https://3526440999-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-MbsbXAOXMfsAfV7pvCu%2F-Mbscs7ZmZkOQqYBhzDl%2Fimage.png?alt=media\&token=2cab69fd-7de6-40e8-b854-23d9cd4dede6)

&#x20;   2\. The commentary info will display the full name and date/time of the last updated commentary
