Appendix A: Using Power BI® with AcceleratorKMS APIs - AcceleratorKMS - Version 3.12 - Help - Hexagon

About this task

These steps are guidance for using Power BI® to collect task, completion, and content data from the AcceleratorKMS APIs. Once the data is gathered, Power BI® can be used to create visuals to assist with analyzing data.

Prerequisites

• Basic knowledge of Power BI® is required.

These instructions are based on Power BI® application version 2.74.5619.862 64-bit.

1. Open AcceleratorKMS and verify your username and password are correct.

2. Open Power BI®.

   A new report is automatically created when you open Power BI®.

3. User: Close the Power BI® Desktop yellow splash screen.

4. On the Home menu, select Get Data > Blank Query to create a new query.

   

   The Power Query Editor operates separately from the main Power BI® window. The yellow icon in the following figure indicates you are in the Power Query Editor.

   

5. In the Power Query Editor window on the right side, enter a name for your report.

   

6. On the View menu, select Advanced Editor.

7. In the Advanced editor window, delete the default text.

   

8. Copy a sample query from the relevant API section and paste into a text editor, such as Notepad.

   Samples include placeholders; they must be modified prior to use.

9. In the text editor,

   1. Replace both occcurences of AcceleratorKMS_URL with the Accelerator URL for your organization.

   2. Replace MyUserName with an AcceleratorKMS username.

   3. Replace MyPassword with an AcceleratorKMS password.

   4. Using the search criteria relevant to the query, replace the sample search criteria in the line starting with Content = Text.ToBinary, so that the desired results are returned.

      • For example, in Completions query use: Content = Text.ToBinary("{""SearchTerm"": ""start"", ""LimitSearchResults"":10}")

      • Returns first 10 completions created within the last six months for content where the title or description includes the term “start” .

   Before and after query examples:

   

   

10. With the modifications made, copy and paste your modified text into the Advanced Editor window.

11. Click Done.

12. At the authentication warning, click Edit Credentials.

    

13. In the Access Web content window, select Anonymous and click Connect.

14. At the data privacy warning, click Continue.

    

    Do not choose Private as a privacy level; it prevents the query from running.

15. Choose one of the following two privacy levels according to your organization's data privacy policy and click Save:

    • Public

    • Organizational

16. Close the Editor window.

We recommend that data only be refreshed in intervals greater than 30 minutes to ensure AcceleratorKMS performance is not impacted. Throttling bounds are in place at the IP address levels as well as across all requests. AcceleratorKMS is typically throttled for 5 minutes between queries for a single user, and 1 minute between queries for different users.

Results

Power BI® is now set to collect data from AcceleratorKMS.