Skip to content

Commit

Permalink
GITBOOK-506: 3.1. IRENT-WB, commenting
Browse files Browse the repository at this point in the history
  • Loading branch information
PreethaS1 authored and gitbook-bot committed Jul 31, 2024
1 parent f77e6fe commit baa9f4a
Show file tree
Hide file tree
Showing 61 changed files with 115 additions and 34 deletions.
Binary file added .gitbook/assets/WB Text field length - 1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/WB Text field length - 2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (1) (1) (1) (1) (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (10) (9).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (10).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (11) (10).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (11).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (12) (6).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (12).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (13) (7).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (13).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (14) (6).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (14).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (15) (7).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (15).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (16) (7).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (16).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (17) (8).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (17).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (18) (5).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (18).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (19) (6).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (19).png
Binary file added .gitbook/assets/image (2) (1) (5).png
Binary file modified .gitbook/assets/image (2) (1).png
Binary file modified .gitbook/assets/image (2).png
Binary file added .gitbook/assets/image (20) (3).png
Binary file modified .gitbook/assets/image (20).png
Binary file added .gitbook/assets/image (21) (3).png
Binary file modified .gitbook/assets/image (21).png
Binary file added .gitbook/assets/image (3) (1) (5).png
Binary file modified .gitbook/assets/image (3) (1).png
Binary file modified .gitbook/assets/image (3).png
Binary file added .gitbook/assets/image (4) (11).png
Binary file modified .gitbook/assets/image (4).png
Binary file added .gitbook/assets/image (5) (13).png
Binary file modified .gitbook/assets/image (5).png
Binary file added .gitbook/assets/image (6) (14).png
Binary file modified .gitbook/assets/image (6).png
Binary file added .gitbook/assets/image (7) (13).png
Binary file modified .gitbook/assets/image (7).png
Binary file added .gitbook/assets/image (8) (12).png
Binary file modified .gitbook/assets/image (8).png
Binary file added .gitbook/assets/image (9) (10).png
Binary file modified .gitbook/assets/image (9).png
Binary file modified .gitbook/assets/image.png
Binary file added .gitbook/assets/ten digit decimal precision.png
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@
* [Data-level comments](working-with-inforiver/8.-commenting-and-collaboration/comments/comments.md)
* [Assign & track tasks](working-with-inforiver/8.-commenting-and-collaboration/comments/comments-1.md)
* [Track changes](working-with-inforiver/8.-commenting-and-collaboration/comments/track-changes.md)
* [Report-level comments](working-with-inforiver/8.-commenting-and-collaboration/comments/report-level-comments.md)
* [Comment settings](working-with-inforiver/8.-commenting-and-collaboration/comments/comment-settings.md)
* [10. Exporting reports](working-with-inforiver/10.-exporting-reports/README.md)
* [Export to PDF & Excel](working-with-inforiver/10.-exporting-reports/export.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Allows you to configure Databricks as a destination for Inforiver writeback. 

After navigating to the add destination page, the following details will have to be entered. 
When you get to the 'Add Destination' page, you have the option of using basic or OAuth authentication. If you choose basic authentication, you will need to enter the following information:

* Host Name
* Warehouse ID
Expand All @@ -14,3 +14,7 @@ After navigating to the add destination page, the following details will have to
<figure><img src="../../../.gitbook/assets/image (60) (1).png" alt=""><figcaption><p>Configuring Databricks as a writeback destination</p></figcaption></figure>

<figure><img src="../../../.gitbook/assets/image (50) (1).png" alt=""><figcaption><p>Steps to set up a writeback destination in Databricks</p></figcaption></figure>

You can also use OAuth-type authentication to log in that ensures a simple and secure login process. The example below illustrates adding a Databricks destination to an existing integration using OAuth-type authentication.

<figure><img src="../../../.gitbook/assets/image (1).png" alt=""><figcaption><p>OAuth type authentication for Databricks destination</p></figcaption></figure>
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ After navigating to the add destination page, the following details must be ente

<figure><img src="../../../.gitbook/assets/image (56) (1).png" alt=""><figcaption><p>Steps to set up a writeback destination in Snowflake</p></figcaption></figure>

You can also use OAuth-type authentication to log in, to ensure a simple and secure login process. The example below illustrates adding a Snowflake destination to an existing integration using OAuth-type authentication.
You can also use **OAuth**-type authentication to log in that ensures a simple and secure login process. The example below illustrates adding a Snowflake destination to an existing integration using OAuth-type authentication.

<figure><img src="../../../.gitbook/assets/1.3. Snowflake OAuth-updated.png" alt=""><figcaption><p>OAuth-type authentication for Snowflake destination</p></figcaption></figure>

Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The **Custom Filter** configuration window has the following options:
If you have set up Matrix filters as well as writeback filters, the writeback filter will always take precedence.
{% endhint %}

### iii) Additional column configuration&#x20;
### 3. Additional column configuration&#x20;

This allows a user to add dimension keys to the writeback table during writeback. This will require the user to provide consent to access all the datasets from the workspace.&#x20;

Expand Down Expand Up @@ -132,7 +132,7 @@ Inforiver reports are often used for high-level aggregations such as Revenue by
* If a high-level dimension category is included in the visual and additional column mapping is chosen, Inforiver will write dimension keys only if there are no conflicts. In case of conflicts, writeback will go through successfully except that the dimension key columns will be written NULL. This will be recorded in the writeback logs. It is recommended that the user add appropriate categories to avoid conflicts.
* Add Date Key only works with Power BI time intelligence generated date hierarchy set in the columns field of the visualization pane.

### iv) Permissions
### 4. Permissions

The permissions option allows control over users who can writeback. It is possible to grant writeback permissions to everyone in your organization or to a select few users to perform writeback. Inforiver leverages Azure Active Directory (AAD), hence finding and granting writeback permissions to your co-workers will be straightforward.&#x20;

Expand All @@ -146,7 +146,7 @@ Selecting this option will display an input field. Users can then specify the em

<figure><img src="../../../.gitbook/assets/add-permissions-email.png" alt=""><figcaption></figcaption></figure>

### v) Webhooks
### 5. Webhooks

Inforiver webhook delivers a JSON payload to any HTTP endpoint. The JSON payload contains essential information about the writeback instance as shown below.

Expand Down Expand Up @@ -205,8 +205,26 @@ To set up Inforiver Webhooks, paste the HTTP endpoint URL in the URL field. Clic

The above are sample workflows that could be triggered using the Inforiver webhook. There are many other workflows possible. Please note that the Inforiver webhook is different from URL as Destination. Inforiver webhook's JSON payload only contains essential information about the writeback table. URL as Destination JSON payload contains the entire writeback table. Learn more [here](../destinations/url-as-destination.md).

### vi) Decimal Precision
### 6. Decimal Precision

You can specify the number of digits after the decimal point to be written back. This is a one-time setup that will apply to all destinations configured for a particular report page. The precision that is set in the destination configuration is displayed in the Decimal Precision section. [Learn more about configuring writeback destinations](../destinations/).
You can specify the number of digits after the decimal point to be written back. This is a **one-time setup** that will apply to **all destinations** configured for a particular report page. While configuring the first writeback destination, you will see a pop-up as shown below, to configure the decimal precision.&#x20;

<figure><img src="../../../.gitbook/assets/image (360).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (4).png" alt=""><figcaption><p>Configuring decimal precision</p></figcaption></figure>

If you require high precision, you can configure Inforiver to write back numerical data with up to ten decimal digits. Any digits beyond 10 will be rounded off.

<figure><img src="../../../.gitbook/assets/image (5).png" alt=""><figcaption><p>10-digit decimal precision</p></figcaption></figure>

The precision that is set in the destination configuration is displayed in the Decimal Precision section. [Learn more about configuring writeback destinations](../destinations/).

<figure><img src="../../../.gitbook/assets/image (360).png" alt=""><figcaption><p>Decimal Precision</p></figcaption></figure>

### 7. Text field length

You can restrict the length of text fields to be written back. The default text length allowed in writeback is 512 characters. While adding the first destination, along with [decimal precision](general-settings.md#id-6.-decimal-precision), you can also restrict the length of text fields to 512 characters or allow writeback up to the maximum limit supported by the backend. This is also a **one-time setup** that will apply to **all destinations** configured for a particular report page. [Learn more about configuring writeback destinations here](../destinations/).

<figure><img src="../../../.gitbook/assets/image (6).png" alt=""><figcaption><p>Configuring text field length</p></figcaption></figure>

The text length that has been set is shown in the Text Length section of the report as below. Note that, if you have restricted the text length and the length exceeds that limit, writeback will fail.

<figure><img src="../../../.gitbook/assets/WB Text field length - 2.png" alt=""><figcaption><p>Long text field truncated</p></figcaption></figure>
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Inforiver filters can detect manually inserted row categories and calculated row

In the example below, the _HighTouch_ and _Vsense_ rows are manual input rows created within the Inforiver visual. Notice how even manual input row categories are detected by the filter.

<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1).png" alt=""><figcaption><p>Filtering manual input row categories</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (3).png" alt=""><figcaption><p>Filtering manual input row categories</p></figcaption></figure>

### 2.2. Column-level filter

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ Access control for all the columns can also be set through the **Manage Columns*

### 3.2. Time interval mapping

When you have a date hierarchy in your rows/columns, you can use the time interval mapping to verify the formats that Inforiver auto-detects. Hover over the<img src="../../.gitbook/assets/image (1) (1).png" alt="" data-size="line">icon to view all the supported date formats.
When you have a date hierarchy in your rows/columns, you can use the time interval mapping to verify the formats that Inforiver auto-detects. Hover over the<img src="../../.gitbook/assets/image (1) (1) (1).png" alt="" data-size="line">icon to view all the supported date formats.

<figure><img src="../../.gitbook/assets/image (2) (1).png" alt=""><figcaption><p>Supported date formats</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (2) (1) (5).png" alt=""><figcaption><p>Supported date formats</p></figcaption></figure>

You can also choose whether to use Power BI sorting or Inforiver sorting. When the **Sort** toggle is enabled, any sorting changes made at Power BI level will not be reflected in the visual. In the example, notice how the Power BI sorting is not applied on the Quarter when the Sort toggle is enabled.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ When you use icons, you have an additional option to align your icons in the gri

<div>

<figure><img src="../../.gitbook/assets/image (3) (1).png" alt=""><figcaption><p>Aligning icons</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (3) (1) (5).png" alt=""><figcaption><p>Aligning icons</p></figcaption></figure>



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ e) On clicking the dropdown, you can find more information and options. The work
Let's now look at Inforiver's commenting capability.

1. [Data-level comments](comments/comments.md)
2. [Assign & track tasks](comments/comments-1.md)
3. [Track changes](comments/track-changes.md)
4. [Comment settings](comments/comment-settings.md)
2. [Report-level comments](comments/report-level-comments.md)
3. [Assign & track tasks](comments/comments-1.md)
4. [Track changes](comments/track-changes.md)
5. [Comment settings](comments/comment-settings.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Report-level comments

In the previous sections, we discussed about adding and tracking data-level comments in a report. Inforiver also supports report-level comments, which will be covered in this section.

Data-level comments enable you to add annotations, mention users, assign tasks and perform other collaborative actions that are specific to a data point. Report-level comments, on the other hand, let you perform all the aforementioned actions while providing an overall summary of the report.

## 1. Add report-level comments

1. Click on **Comments** dropdown and then **Report Level Comments**. In the side panel, enter the comments.&#x20;

<figure><img src="../../../.gitbook/assets/image (8).png" alt=""><figcaption><p>Adding report-level comments</p></figcaption></figure>

2. On clicking **Post**, the comments get displayed on the side panel. You can edit/delete the comment by clicking on the corresponding icons in the top right.

<figure><img src="../../../.gitbook/assets/image (9).png" alt=""><figcaption><p>Report-level comment added</p></figcaption></figure>

{% hint style="info" %}
All features of data-level commenting are also supported in report-level commenting, including formatting text, adding hyperlinks, [mentioning users](comments.md#id-2.-mention-other-users), [replying to comments](comments.md#id-3.-reply-to-comments), [email notifications](comments.md#id-6.-email-notifications) and [assigning tasks to users](comments-1.md#id-1.-assign-tasks).
{% endhint %}

## **2. Lock/un-lock thread**

A report-level comment that has been added can be locked to prevent further editing and replies. Click on the three-dot icon and select **Lock Thread.**&#x20;

<figure><img src="../../../.gitbook/assets/image (11).png" alt=""><figcaption><p>Lock thread</p></figcaption></figure>

The comment thread is locked and greyed out as below:

<figure><img src="../../../.gitbook/assets/image (12).png" alt=""><figcaption><p>Locked comment thread</p></figcaption></figure>

To unlock a thread, click on the 'Unlock' icon highlighted below, so that users can reply to and edit the thread.

<figure><img src="../../../.gitbook/assets/image (14).png" alt=""><figcaption><p>Unlock thread</p></figcaption></figure>

## 3. Resolve/re-open thread

1. When a task is assigned, it's status is 'Open'.

<figure><img src="../../../.gitbook/assets/image (15).png" alt=""><figcaption><p>Assigning a task</p></figcaption></figure>

2. To change the task status, click on the three dots and select **Resolve thread**.

<figure><img src="../../../.gitbook/assets/image (16).png" alt=""><figcaption><p>Resolve thread</p></figcaption></figure>

3. The thread is marked as resolved.

<figure><img src="../../../.gitbook/assets/image (17).png" alt=""><figcaption><p>Task set to 'Resolved'</p></figcaption></figure>

4. Resolved tasks can be reopened if required, by clicking on the 'Undo' icon. Alternatively, replying to any resolved thread will automatically re-open it.

<figure><img src="../../../.gitbook/assets/image (19).png" alt=""><figcaption><p>Re-open thread</p></figcaption></figure>

## 4. Sort/track tasks

If you want to quickly navigate through a long comment thread with multiple replies, use the 'Sort by' option to sort them from newest to oldest or vice versa.

<figure><img src="../../../.gitbook/assets/image (20).png" alt=""><figcaption><p>Sort and track tasks</p></figcaption></figure>
Loading

0 comments on commit baa9f4a

Please sign in to comment.