Note! Use of many comments features require the installation of Vizlib Server. Features included in the trial are limited.
Quick setup for trial version (Full description below)
Activation of Vizlib Server comments
Activate comments for the Finance Report in the property panel. This will connect the Finance Report to the Vizlib cloud server.
Choose measures where comments are allowed
Still in the section for comments. Choose to activate all measures where it should be allowed to comment.
Done! Start commenting!
Comments are accessed through the small icon next to the numbers in the cells of the activated measures.
Setting up the server (paid version)
Connecting to the server
Turing on comments activate the connection to the server. Connect to the desired Finance Report stream that has been set up in the Vizlib Management Console (VMC). The server and server port can be changed if needed.
Enable comments for all measures where comments should be possible. If a period (such as month or year) is used as top dimension then typically "Use top dimension as period" is activated to connect all comments to the right column. The "Comment Period" is in that case not active since the dimension is used.
The row of the first dimension in the Finance Report is always picked up and stored with the comment to make sure each comment is connected to the correct row of the report. Comments are only possible on the first dimension and not on expanded rows.
The "Comment Measure Key" defaults to the name of the measure (In the example below it would be "Actual".)
Further customization can be made by modifying "Comment Measure Key" with any Qlik expression. For example it is possible to use dynamic column names and then something like "='Actual vs '&vTargetType" could be used to make sure the comment connects to whatever value currently active in the variable vTargetType.
Also the Comment Period can be customized with expressions. For example if comments should be connected to the latest selected period an expression like "=Max(YearMonth)" could be used.
Comments can be allowed/disallowed based on an expression. Leaving an empty string will allow comments while all other results of the condition expression will disallow comments.
For the more specific use case of financial periods that are opened or closed a special feature is available. The access to commentary can then be controlled through the Qlik Sense Management Console (QMC) and the custom property "VizlibFinanceReport_OpenPeriod". Commenting is then only allowed when the Comment Period property matches the custom property "VizlibFinanceReport_OpenPeriod"
Hierarchy groups allows a connection between comments and the data in the application. When the setting is enabled the data in the hierarchy groups is stored with the data.
There are several different ways to configure hierarchies. The rules are defined by the Hierarchy Group Mode setting. Default value is Active or lower level.
NOTE! Active hierarchy level is the lowest level in a hierarchy group that has selections in the specified field. E.g. If you have selected 2014 in field Year and 2014-Jan in YearMonth, in a hierarchy group defined with Year, YearMonth and Date, the Active hierarchy level is equal to YearMonth.
Adding Hierarchy Groups
It is recommended that you use fields with a fewer number of values, because the number of fields and field values impact query performance. If the query gets too complex comments will not be fetched. Number of values in hierarchy group field are limited to the first 100 values. Design your hierarchy groups wisely. Especially the top fields in each hierarchy group if required selections is disabled, because comments made with no selections in hierarchy group will be associated with the top field. Updating hierarchy groups will most likely filter out some/all older comments associated with previous hierarchy groups that do not get a match in the updated configuration.
Expand hierarchy group and click the Add Hierarchy Group button
Click <Select a value> to open up drop down
Select the field to use as a hierarchy group level field. Keep adding as many fields as needed but make sure that each field is in a strict hierarchy with the levels above.
Period, Group A, Group B and Group C
For Hierarchy Groups A-C you can use any fields you choose. Common options are geographical, organisational or product group related fields. Again, make sure the dimensions within each hierarchy are an aggregate of the level below.
Hierarchy groups with Require selections disabled, allows for adding comments without selections in the fields defined in the hierarchy group. Comments, without selections, will be associated with the top field in the hierarchy group with no value.
Require selections enabled, requires a selected value in one of the fields defined in the hierarchy group.
Streams allows you to configure additional security rules around commentary.
By default all newly created streams have the Secure Stream option disabled. If a Stream is not a Secure Stream, all users have Read and Write access to that Stream. It’s possible to limit user access to only Read access by changing the access type in the Manage Access modal.
Use the Manage Access button to open up the Manage User Access modal. In the Manage User Access modal, it’s also possible to upgrade the access to Admin, which grants users Read and Write access and enables users to delete comments created by other users.
Secure Stream comments will not be accessible unless a user has either Read, Write or Admin access to the Stream.
Use the Manage Access button to open up the Manage User Access modal. In the Manage User Access modal, it’s possible to grant the user Read, Write and Admin access to the specific stream.
NOTE! Write Access also grants Read Access. Admin Access also grants Write and Read Access.
Secure Hierarchy Groups
Enabling the secure hierarchy groups only allows uses with access to the hierarchy to use the comments.