Foundation Data & Integrations
Power BI Integration
8 min
the purpose of this document is to provide an overview of the integration architecture required to support an integration with power bi from servicely while the servicely platform already provides powerful tools for point in time reporting and operational analysis, the goal of this integration is to extend the reporting and analysis capabilities even further microsoft power bi specializes in advanced reporting and analysis techniques, like trending, forward looking projections, aging and complex visualisations in this document, we outline the integration process between servicely and power bi, involving the setup of a local database and api configuration for data retrieval this architecture is meant to optimise the use of power bi's advanced capabilities for more insightful reporting, while minimizing the resource load on your servicely environment from frequent data syncing the core process involves setting up a local database in your environment, followed by configuring and using an api to retrieve datasets from our servicely platform this data can be pulled on a schedule once every 24 hours, utilising pagination, with a pull limit of 200 records per page, ensuring a balanced usage of resources to ensure little impact to your day to day operations the database populated with this data then connects with power bi, serving as the foundation for your reporting and analytics needs note the database created and power bi are external technologies to our platform, this document does not provide detailed setup instructions for these customers should refer to microsoft's own guidance and support for any necessary setup and configuration instructions of powerbi and contact your database administrator for any setup or troubleshooting needs pre requisites before getting started it is important that customers have the following servicely system administrator account to configure the integration from servicely, the logged on user must have system administrator role this is required to help set up the token and or user that you wish to use pulling the data from servicely does not need a user with the system administrator role however, it should be noted that whatever user your use for the api will need to have permission to read the records within servicely database setup customers will need to setup a database within their own environment this database will need to retreive the required tables / datasets via an api from servicely for powerbi to then create and run reports off power bi subscription the assumption of this document is that customers will have a licensed copy of microsoft power bi although trial versions of power bi are available, servicely cannot be sure that the integration capabilities referenced in this document are possible power bi administrator customers must have an experienced microsoft power bi administrator who is able to work with the database administrator to then configure the integration with servicely this document does not include detailed setup instructions for power bi power bi desktop the power bi desktop version is required setup the first load of data and publishing in the workspace the integration process identify the servicely processes the starting point for customers is to determine what processes they would like to integrate with power bi for reporting purposes all out of the box processes such as incident management, problem management, request management, human resources and many others are available for integration if your organisation has configured your own processes these are also available for integration nearly all tables are accessible out of box from our api toolset, with only a few excluded being system configuration orientated tables determine the table api each servicely table has a unique api which is required for this integration from a fundamental level, this document details basic usage of the out of box get rest api more detailed information of this can be found here get request retrieving records docid\ scdfmk8b0xoec3wpyjfql the table below includes examples of how you may reach these endpoints servicely process servicely table name servicely api endpoint incident management incident https //<\<instancename>> servicely ai/v1/incident problem management problem https //<\<instancename>> servicely ai/v1/problem request management request https //<\<instancename>> servicely ai/v1/itsmrequest custom process (e g fleet management) fleetmanagement https //<\<instancename>> servicely ai/v1/c fleetmanagement the table name of custom processes may vary depending on the naming structure used during the implementation to determine what the table name is, you can navigate to the list of the records you want to look at and then shift click the copy button on the filter for more details you can scroll to the tip copying queries from the ui in the following page get request retrieving records | tip copying queries from the ui https //docs servicely atlassian net/wiki/spaces/sd/pages/2077556747/get+request+ +retrieving+records#tip%3a copying queries from the ui as we strongly recommendating implementing pagination and also only retrieving the past 24 hours updated records daily, the end result query may appear something similar to this https //<\<instancename>> servicely ai/v1/incident?query={"and" \[{"fieldname" "updatedon","operator" "=","value" "today()","displayvalue" "today"}]}\&page size=200\&page=2\&order desc=createdon database setup a database administrator from your organisation will need to determine what database type (e g sql) to use for storing the data from servicely that is required for powerbi to integrate this database will serve as a data source for your power bi reports after setting up the database, use the api key (refer to section 3 2) to fetch the required datasets from servicely ensure this is configured to fetch up to 200 records per page and scheduled for once every 24 hours this helps in maintaining the performance and integrity of the solutions we would typically suggest doing this out of hours when possible power bi setup the steps provided below are based on servicely’s understanding of the power bi setup requirements note these may vary between customers, versions etc therefore servicely encourages a microsoft power bi subject matter / technical expert verifies these for accuracy power bi services using a power bi desktop version, create a workspace where the servicely reports will be published setup access using the workspace created the administrator can provide access to the required stakeholders to be able to consume the servicely reports connect to database refer to step 3 3 where the powerbi and database administrator(s) will need to work together to form the api connection between powerbi and servicely field label changes through the integration, servicely passes the field names as they appear in the servicely tables customers are encouraged to review these and make any necessary changes for example, the out of the box “assignment group” field has table name of “assignmentgroup” so customers might want to change this to “assignment group ” fields created specifically for your implementation (i e not provided out of the box) will have a “c ” in front of it for example you might have setup a field with a servicely form label of “background information” that may result in a field name of “c backgroundinformation”, therefore in power bi you might want to change this to “background information” for consistency report creation and analysis at this point, reports and analytics can be created through powerbi need further support? servicely support for any servicely related instructions or issues, please don’t hesitate to reach out to our customer support team system administrators can do this by logging onto support portal ( https //support servicely ai https //support servicely ai ) or via email support\@servicely ai mailto\ support\@servicely ai database support for any issues or troubleshooting regarding your database or connectivity issues between the database and servicely, please also contact your database administrator power bi support for issues or instructions specifically related to power bi, you should refer to the power bi support resources available online or contact your power bi / microsoft support team