How do I see all comments made in Collibra by read-only users

Hi all,

I would like to create a report in Collibra to see all comments made by regular (non-stewards) users of Collibra. Because comments isn’t an attribute that can be added to report in Global view I can’t see them all together. As a head of Data Governance I would like to monitor user’s feedback on daily basis to quickly react to their needs.

Thank you,
Serguie

sergueiantonov

Posted 3 years ago · Edited 1 year ago·Last reply 3 years ago

7 comments

arthurburkhardt

·3 years ago · Edited

There is no workflow to do that automatically, you have to build one with the commentApi.
Or you can use the rest API.

Here, I’ll give you two step-by-step instructions:

Option	Pros	Cons
Using PowerQuery in Excel	Immediately available in excel Automated refresh from Excel	Requires username/password (no SSO available) Non-human readable timestamps (java millis) Only User IDs (no userName) Restricted to 10000 records max
OutputModule	Customizable Can generate excel file directly with human-redable format	Requires manual copy paste in the API docs or programming (python, java, etc.)

Using PowerQuery in Excel:

For example in Excel, you can go to Data > From Web

Load this url: https://yourinstance.collibra.com/rest/2.0/comments?limit=10000

Select “Basic” (Collibra does not support SSO authentication for APIs) and enter your username and password, then press “Connect”

It will open PowerQuery and enable you to extract the information

Right click on the header (List), then To Table

Using the outputModule API

Step 1. Go to the API docs of your instance > Rest Core API

Step2. Find the outputModule excel-file endpoint and click “Try it out”

Step 3. Paste the following query in the request body form and press “Execute”

OutputModule Query

---
TableViewConfig: 
    Resources: 
      Comment:
        Id: {'name':'id'}
        CreatedOn: {'name':'createdOn'}
        User:
          - linkType: CREATED
            UserName: {'name':'createdBy'}
          - linkType: MODIFIED
            UserName: {'name':'lastModifiedBy'}
        LastModified: {'name':'lastModified'}
        Content: {'name':'content'}
        ParentComment:
          Id: {'name':'parentCommentId'}
        Asset:
          Id: {'name':'assetId'}
          Signifier: {'name':'assetName'}
        Domain:
          Id: {'name':'domainId'}
          Name: {'name':'domainName'}
        Community:
          Id: {'name':'communityId'}
          Name: {'name':'communityName'}
    Columns:
    - Column: {'fieldName':'id'}
    - Column: {'fieldName':'createdOn'}
    - Column: {'fieldName':'createdBy'}
    - Column: {'fieldName':'lastModified'}
    - Column: {'fieldName':'lastModifiedBy'}
    - Column: {'fieldName':'associatedResourceId'}
    - Column: {'fieldName':'associatedResourceType'}
    - Column: {'fieldName':'content'}
    - Column: {'fieldName':'parentCommentId'}
    - Column: {'fieldName':'assetId'}
    - Column: {'fieldName':'assetName'}
    - Column: {'fieldName':'domainId'}
    - Column: {'fieldName':'domainName'}
    - Column: {'fieldName':'communityId'}
    - Column: {'fieldName':'communityName'}

Step 4. Copy the id, navigate to the /files/{fileId} endpoint, press “Try it out”, paste the ID then press execute

Step 5. Click “Download the file”, rename it to a correct name file (e.g. “collibra-comments.xlsx”) and you’re done!

Anyway… Not super easy to extract comments for reporting… Best of luck!

arthurburkhardt

·3 years ago · Edited

There is no workflow to do that automatically, you have to build one with the commentApi.
Or you can use the rest API.

Here, I’ll give you two step-by-step instructions:

Option	Pros	Cons
Using PowerQuery in Excel	Immediately available in excel Automated refresh from Excel	Requires username/password (no SSO available) Non-human readable timestamps (java millis) Only User IDs (no userName) Restricted to 10000 records max
OutputModule	Customizable Can generate excel file directly with human-redable format	Requires manual copy paste in the API docs or programming (python, java, etc.)

Using PowerQuery in Excel:

For example in Excel, you can go to Data > From Web

Load this url: https://yourinstance.collibra.com/rest/2.0/comments?limit=10000

Select “Basic” (Collibra does not support SSO authentication for APIs) and enter your username and password, then press “Connect”

It will open PowerQuery and enable you to extract the information

Right click on the header (List), then To Table

Using the outputModule API

Step 1. Go to the API docs of your instance > Rest Core API

Step2. Find the outputModule excel-file endpoint and click “Try it out”

Step 3. Paste the following query in the request body form and press “Execute”

OutputModule Query

---
TableViewConfig: 
    Resources: 
      Comment:
        Id: {'name':'id'}
        CreatedOn: {'name':'createdOn'}
        User:
          - linkType: CREATED
            UserName: {'name':'createdBy'}
          - linkType: MODIFIED
            UserName: {'name':'lastModifiedBy'}
        LastModified: {'name':'lastModified'}
        Content: {'name':'content'}
        ParentComment:
          Id: {'name':'parentCommentId'}
        Asset:
          Id: {'name':'assetId'}
          Signifier: {'name':'assetName'}
        Domain:
          Id: {'name':'domainId'}
          Name: {'name':'domainName'}
        Community:
          Id: {'name':'communityId'}
          Name: {'name':'communityName'}
    Columns:
    - Column: {'fieldName':'id'}
    - Column: {'fieldName':'createdOn'}
    - Column: {'fieldName':'createdBy'}
    - Column: {'fieldName':'lastModified'}
    - Column: {'fieldName':'lastModifiedBy'}
    - Column: {'fieldName':'associatedResourceId'}
    - Column: {'fieldName':'associatedResourceType'}
    - Column: {'fieldName':'content'}
    - Column: {'fieldName':'parentCommentId'}
    - Column: {'fieldName':'assetId'}
    - Column: {'fieldName':'assetName'}
    - Column: {'fieldName':'domainId'}
    - Column: {'fieldName':'domainName'}
    - Column: {'fieldName':'communityId'}
    - Column: {'fieldName':'communityName'}

Step 4. Copy the id, navigate to the /files/{fileId} endpoint, press “Try it out”, paste the ID then press execute

Step 5. Click “Download the file”, rename it to a correct name file (e.g. “collibra-comments.xlsx”) and you’re done!

Anyway… Not super easy to extract comments for reporting… Best of luck!

cagriozbakay

·3 years ago · Edited

@arthur.burkhardt Super helpful!!! Thanks!

arthurburkhardt

·3 years ago · Edited

This is not possible out of the box.
All possible solutions require development:

You can execute a workflow that will query the data, format as Excel and allow you to download a tailored report providing granular details
You can export the data in a reporting database, then have it accessible through a BI tool, SQL or excel.
Extract the data through the rest APIs (you can even do it directly in excel)

arthurburkhardt

·3 years ago · Edited

This is not possible out of the box.
All possible solutions require development:

You can execute a workflow that will query the data, format as Excel and allow you to download a tailored report providing granular details
You can export the data in a reporting database, then have it accessible through a BI tool, SQL or excel.
Extract the data through the rest APIs (you can even do it directly in excel)

sergueiantonov

OP3 years ago · Edited

arthur.burkhardt:

You can execute a workflow that will query the data

Thank you for recommendation! Which workflow can pull comments out of Collibra?

daniel

·3 years ago · Edited

Hi Serguei,

You would need to build this workflow, there isn’t one out of the box.
You would likely use com.collibra.dgc.core.api.dto.instance.comment FindCommentsRequest.Builder to look for comments and then filter the results based on date to remove ones you have already seen (e.g. since last run date of some sort).
Personally I find the REST APIs easier to deal with over workflows to get data into python directly, but both can do the trick