Use Visier Data in Power BI

Create reports in Power BI by fetching data from Visier.

Who can use this feature?

  • Enterprise API User

Not sure if you have this feature or capability? Reach out to your administrator.

Overview

If you want to use your Visier data in Power BI Desktop, you can use Visier's Power BI plugin to fetch aggregate and table data from Visier to create reports in Power BI. Visier users with the appropriate data security access can get data out of Visier to use in Power BI.

Prerequisites

  • Have a Visier tenant that contains data.
  • Have a Viser user account. You can log in with your username and password or single sign-on (SSO) if your organization uses SSO.
  • Have access to data in Visier. You can only bring Visier data into Power BI if your Visier user account is assigned data security access to that data. For more information about data security in Visier, see Data Security for a Permission.
  • Retrieve a Visier API key. For more information, see Generate an API Key.
  • Do one of:
    • Download the VisierDataConnectorSigned.pqx file and register the certificate thumbprint. The PQX file allows you to connect to Visier from Power BI by registering Visier as a trusted third-party connector. To register the certificate, use this thumbprint: 8A3D8EF28E77A58913F13D531820E74C71D41952. For more information, see Trusted third-party connectors. If you're able to edit your registry, we recommend this method.
    • Download the VisierDataConnector.mez file. The MEZ file allows you to connect to Visier from Power BI without editing your registry.

      Note: For more information about the latest PQX and MEZ files, see File history.

Connect Visier data to Power BI

After completing the prerequisites, you're ready to connect your data to Power BI. You must first move the PQX or MEZ file into your Power BI application folder. If using the MEZ file, there is an additional step to allow Power BI to open the extension.

Step One: Move the Visier data connector file into Power BI

  1. On your local device, find your Power BI application folder; for example, YourHome\Documents\Power BI Desktop.
  2. In the Power BI Desktop folder, open the Custom Connectors folder.
  3. In the Custom Connectors folder, paste the VisierDataConnectorSigned.pqx or VisierDataConnector.mez file.

Step Two: Allow Power BI to open the VisierDataConnector extension

Note: If using the PQX file, you can skip this step.

  1. On your local device, launch Power BI Desktop.
  2. In Power BI, click File > Options and settings > Options > Security.
  3. In Security, under Data Extensions, select (Not Recommended) Allow any extension to load without validation or warning.

    Note: Visier is not yet certified with Power BI. If you do not select this option, you cannot load Visier data into Power BI using the MEZ file.

  4. To apply your change, click OK.
  5. Restart Power BI Desktop.

Step Three: Authorize Visier access in Power BI

  1. On your local device, launch Power BI Desktop.
  2. In Power BI, click File > Get data > Get data to get started.
  3. In the Get Data dialog, in the search bar, type Visier and then click VisierDataConnector (Beta).
  4. Click Connect.
  5. In the Visier Data Connector dialog, provide the following credentials:
    • Tenant vanity name: The vanity name in your Visier URL; for example, if your Visier URL is jupiter.visier.com, your tenant vanity name is jupiter.
    • Service access API key: Your Visier solution's API key; for example, YRggWt8z047rJPjyjxVZa. To get your API key, see Generate an API Key.
  6. Optional: Select a login method:
    • OAuth 2.0 is the default.
    • If your organization uses single sign-on (SSO) to log into Visier and you have access to a user account that bypasses SSO, select the Non-SSO login option. For more information about setting up Bypass Users, see Set Up Single Sign-On.
    • If you are publishing the report with Visier data to the Power BI Service and scheduling data refreshes, select the Direct Username-Password option. This enables credential caching so you don't have to re-authenticate for data refresh.
  7. After providing your credentials, click OK.
  8. Click Sign In.
  9. On the Visier sign in page, provide your user credentials (username and password or SSO) and then click Sign In.
  10. Click Connect.

    Result: If successful, Power BI launches the Navigator dialog. In the Navigator dialog, you can select data from your Visier solution.

Create reports in Power BI

Note:  

Now that your Visier data is accessible in Power BI, you can create reports in Power BI powered by Visier data. This section describes how to access Visier data using Power BI's Navigator and some of the settings you can use to create meaningful data visualizations. This article doesn't describe every action you can take to visualize data in Power BI. For more information about using Power BI, see Create reports and dashboards in Power BI - documentation.

Select a metric or list of records

The Navigator dialog contains a list of every analytic object that your Visier user can access; for example, Employee and Employee Exit. If you expand an object, you can then select its Metrics or Records, or form a query, as described next.

  • Metrics: All metrics associated with the object. For example, if you select Employee, you can then select a metric like Headcount or Absence Ratio.
  • Records: A list of members associated with the object. For example, if you select Employee, you can then select snapshot.
  • JSON Aggregate query: A single-line JSON query to retrieve aggregate data for the analytic object. For more information about JSON aggregate queries, see JSON query code samples.
  • JSON Snapshot query: A single-line JSON query to retrieve snapshot data for the analytic object. For more information about JSON snapshot queries, see JSON query code samples.
  • Multi-Metric query: More than one metric from which to retrieve data for the analytic object.

Set the analysis context

After you select a metric or snapshot, you can then set the analysis context for your visualization.

If you selected a metric or multi-metric query, you can set the following options.

  • Metrics: If you selected Multi-Metric query, select one or more metrics from the list.
  • Time period count: The number of time periods to retrieve, such as 6 months.
  • Time period type (optional): The type of time period to measure data, such as MONTH or QUARTER. If undefined, the default is YEAR.
  • Date type: Select a method to specify the time instant to query from.
    • Update automatically (Complete & Non-complete periods): If Time direction is BACKWARD, use the start of the most recent period. If Time direction is FORWARD, use the start of the earliest period.
    • Update automatically (Complete periods): If Time direction is BACKWARD, use the start of the most recent complete period. If Time direction is FORWARD, use the start of the earliest complete period.
    • Use specified value in Date field: Use the date from which to retrieve data as defined in the Date field.
  • Date (optional): The date from which to retrieve data. Required if Date type is Use specified value in Date field. Otherwise, leave empty.
  • Time direction (optional): The direction to return data, such as BACKWARD. If undefined, the default is BACKWARD.
  • Trailing period count (optional): The number of trailing time periods to retrieve, such as 6 months. Trailing period is only relevant for time-based metrics such as rates. If undefined but the trailing period type is defined, the default is 1.
  • Trailing period type (optional): The type of trailing period to measure data, such as MONTH or QUARTER. Trailing period is only relevant for time-based metrics such as rates. If undefined but the trailing period count is defined, the default is MONTH.
  • Filter by (optional): The attribute to filter the data by.
  • Group by (optional): The attribute to group the data by.

If you selected a snapshot, you can set the following options.

  • Properties: The attribute to retrieve data for.
  • Sort by (optional): The attribute to sort the data by.
  • Sort order (optional): Whether to sort results in ascending or descending order. If undefined, the default is SORT_ASCENDING.
  • Date type: Select a method to specify the time instant to query from.
    • Update automatically (Complete & Non-complete periods): If Time direction is BACKWARD, use the start of the most recent period. If Time direction is FORWARD, use the start of the earliest period.
    • Update automatically (Complete periods): If Time direction is BACKWARD, use the start of the most recent complete period. If Time direction is FORWARD, use the start of the earliest complete period.
    • Use specified value in Date field: Use the date from which to retrieve data as defined in the Date field.
  • Date (optional): The date from which to retrieve data. Required if Date type is Use specified value in Date field. Otherwise, leave empty.
  • Time period type (optional): The type of time period to measure data, such as MONTH or QUARTER. If undefined, the default is YEAR.
  • Time period count: The number of time periods to retrieve, such as 6 months.
  • Time direction (optional): The direction to return data, such as BACKWARD. If undefined, the default is BACKWARD.

If you selected a JSON query, paste a single-line JSON query. For more information, see JSON query code samples.

When finished, click Apply. Power BI generates a data preview based on the defined analysis context. If the data preview looks good to you, click Load.

Adjust the data settings

Now that you have data in Power BI, you can configure the data settings to change the representation of data. For example, you can rename the metric or select the Date Hierarchy type. The following steps are a few options you can do to adjust the data settings. For more information about the Data pane, see Work with Data view in Power BI Desktop.

  1. In the Data pane, expand the metric or snapshot.
  2. Optional: Expand DateInRange > Date Hierarchy and then select the Date Hierarchy type, such as MONTH.
  3. Optional: If you selected a metric, beside Measures, click the More options button > Rename. You can then type a new name for the selected metric.
  4. Optional: If you defined any filters or group bys, rename them by clicking the More options button > Rename.

Build a visualization

With the data settings configured, you can now build your visualization with the data. The following steps are a few options you can do to build your visualization. For more information about visuals, see Visualizations in Power BI reports.

  1. In the Visualizations pane, select a visual type, such as a pie chart.
  2. In the Data pane, drag the group by (if available) to the Visualizations pane under Y-axis.
  3. In the Data pane, drag the metric to the Visualizations pane under X-axis.
  4. To hide zeros from the visual, do the following:
    1. In the Data pane, drag the metric to the Filters pane.
    2. Expand the metric.
    3. Change Show items when the value to Is greater than and 0.
    4. When finished, click Apply filter.

Save or publish your work

When finished building your report, you can save it to your local device or publish it to the web server. Either of these options retain the data at the time that you built the report. For more information, see Export reports from Power BI to PDF or Publish to web from Power BI.

Tip: To refresh your Visier data in Power BI, the next time you launch Power BI after your first session using Visier data, click Refresh Now on the pop-up banner.

Connect to Power BI Service

After creating a report in Power BI Desktop, you can optionally publish the report to Power BI Service. If you publish the report to Power BI Service, you can manually refresh your report's data or schedule data refreshes on a daily or weekly basis.

To connect to Power BI Service:

  1. Install an on-premises data gateway. We recommend a standard gateway, but if your user doesn't have admin access, you can install a personal mode gateway. For more information, see Install an on-premises data gateway.
  2. After the gateway is installed, set up the gateway cluster to use Visier's custom connector, as shown next. The gateway's service user must have access to your Power BI Custom Connector's folder. For more information, see Use custom data connectors with an on-premises data gateway.

  3. In your report in Power BI Service, navigate to Semantic models and schedule daily or weekly data refresh, using the established connection as shown next. Ensure, the Direct Username-Password option is selected as the Authentication method.

  4. Optional: To manually refresh your data in Power BI Service, click Refresh > Refresh now.

Troubleshooting

If you run into errors with Visier's Power BI plugin, try the following troubleshooting methods.

Error message

Troubleshooting method

"We're unable to connect. Please delete your credentials and try again later."

"The remote name could not be resolved: {url}"

"Cannot begin authentication at {url}"

"We couldn't authenticate with the credentials provided. Please try again."

  • Verify that the Tenant vanity name and Service access API key are valid. These credentials provide access to the Visier login page.
  • Verify that the login user's IP address is not restricted by the tenant's network access settings. For more information, see Set Up Network Access.

"User has insufficient data capabilities."

The Visier user must have a profile with the capability Data: API (View Level). To assign a profile to a user, see Manage the profiles assigned to a user. You can assign any profile that has at least Data: API (View Level). To check whether a profile has the correct capability, in Visier, navigate to Tenant > Profiles, select the profile, and then check the Data capability's View level.

After assigning the necessary data capability to the user, return to Power BI.

  1. On your local device, launch Power BI Desktop.
  2. In Power BI, click File > Options and settings > Data source settings > Clear all permissions.
  3. When finished, try authenticating the user in Power BI again.

"User has insufficient data access."

The Visier user must have a permission with sufficient data access. To update the user's permissions, see Assign Permissions to a User. Make sure that the assigned permission gives access to the data being used in Power BI. When finished, publish the project in which you updated the user's permissions to production. For more information, see Publish Project Changes.

After updating the user's data access, return to Power BI.

  1. On your local device, launch Power BI Desktop.
  2. In Power BI, click File > Options and settings > Data source settings > Clear Permissions.
  3. When finished, try authenticating the user in Power BI again.

"Aggregate or Snapshot query returned empty results for the selected options. Please modify options and try again."

There may not be any data in the selected time range. Modify the selected date or time period count and then load the query again.

"Value cannot be null. Parameter name: uriString"

If the authentication window for Power BI can't open, you can use your default web browser to authenticate.

  1. In Power BI, click File > Options and settings > Options > Security.
  2. Under Authentication Browser section, clear the Use my default web browser box.
  3. Click OK.
  4. Try to authenticate again.

"Failed to save modifications to the server. Error returned: The provider ‘Microsoft.PowerBI.OleDb' is not registered. The following system error occurred: Class not registered."

If you get this error during authentication:

  1. Re-install Power BI Desktop.
  2. When finished, try to authenticate again.

If the above methods aren't applicable to you, check your log messages in Power BI, as described next.

  1. On your local device, launch Power BI Desktop as Administrator.
  2. In Power BI, click File > Options and settings > Options > Diagnostics > Enable tracing.
  3. Click OK.
  4. In Power BI, reproduce the error that you ran into previously. For example, if you ran into an error during authentication, go through the authentication steps again to make the error occur again.
  5. In Power BI, click File > Options and settings > Options > Diagnostics > Open crash dump/traces folder.
  6. In the folder, find the latest modified Microsoft.Mashup.Container.NetFX45... file.
  7. Download the file to your local device.
  8. Send the file to Visier for further investigation. You can send the file to Visier by filing a support case.

JSON query code samples

Selection of code samples that demonstrate the use of the JSON query builder. Copy and edit these code samples to suit your needs. For more samples, see Visier's Data Query API Code Samples.

Note: Power BI doesn't support multi-line JSON queries. Before pasting your query into Power BI, convert it to single-line format. You can convert JSON with an online tool such as JSON Formatter.

Aggregate query

This sample query loads 3 months of data for Average Direct Span of Control and Headcount filtered by Able to Remote Work employees backwards from January 1, 2023. The data is grouped by Absence Hours.

Copy
JSON aggregate query
{
  "query": {
    "source": {
      "metrics": {
        "columns": [
          {
            "id": "wfaStructureSpanOfControlMeasure",
            "columnName": "Average Direct Span of Control"
          },
          {
            "id": "employeeCount",
            "columnName": "Headcount"
          }
        ]
      }
    },
    "axes": [
      {
        "dimensionLevelSelection": {
          "dimension": {
            "name": "Employee.Absence_Hours",
            "qualifyingPath": "Employee"
          },
          "levelIds": [
            "Employee.Absence_Hours_level"
          ]
        }
      }
    ],
    "filters": [
      {
        "selectionConcept": {
          "name": "ableToRemoteWork",
          "qualifyingPath": "Employee"
        }
      }
    ],
    "timeIntervals": {
      "fromDateTime": "2023-01-01T00:00:00.000",
      "intervalPeriodType": "MONTH",
      "intervalPeriodCount": 1,
      "intervalCount": 3
    }
  }
}

Snapshot query

This sample query loads 3 months of employee exit data backwards from January 1, 2023. Properties loaded include the employee ID of the employee who exited the organization, their age, and the effective date. The data is sorted in descending order by the Effective Date column.

Copy
JSON snapshot query
{
    "source": {
        "analyticObject": "Employee_Exit"
    },
    "columns": [
        {
        "columnName": "Employee age",
        "columnDefinition": {
              "property": {
                "name": "Employee.Age",
                "qualifyingPath": "Employee"
              }
            }
        },
        {
        "columnName": "Employee ID",
        "columnDefinition": {
              "property": {
                "name": "Employee.EmployeeID",
                "qualifyingPath": "Employee"
              }
            }
        },
        {
            "columnName": "Effective Date",
            "columnDefinition": {
              "effectiveDateProperty": {}
            }
        }
    ],
    "sortOptions": [
        {"columnIndex": 2, "sortDirection": "SORT_DESCENDING"}
    ],
    "timeIntervals": {
      "fromInstant": "1672531200000",
      "intervalPeriodType": "MONTH",
      "intervalPeriodCount": 1,
      "intervalCount": 3
    }
}

File history

Download the VisierDataConnectorSigned.pqx file.

Download the VisierDataConnector.mez file.

Version Last updated date Changes

1.7.0

September 4, 2024

  • Added Direct Username-Password login method. This enables credential caching so users don't have to re-authenticate for automated data refresh when using the Power BI Service.

1.6.0

June 12, 2024

  • For snapshot queries, you can now filter by selection concepts.
  • Users with a Visier account that bypasses single sign-on can now authenticate and use the connector.

1.5.0

May 1, 2024

  • Renamed "list" query to "snapshot" query to align with the Visier Data Query API. For more information, see "Query a series of detailed snapshots" in API Reference.
  • Added options to query the latest or earliest complete data period.
  • For snapshot queries, date properties now return values in Date format. Before, date properties returned values in Epoch milliseconds.

1.4.0

March 13, 2024

  • You can now use a signed connector file, VisierDataConnectedSigned.pqx, to register Visier as a trusted third-party connector. If using the PQX file, you no longer have to use the MEZ file.
  • Added support for refreshing data in Power BI Service. For more information, see Connect to Power BI Service.
  • Added SQL-like query functionality. You can specify a SQL-like query for Visier's Data Query API to retrieve results. For more information, see /v1/data/query/sql in API Reference.
  • You can now retrieve overlay data from Visier.

1.3.0

February 21, 2024

  • Added additional logging capability for debugging purposes. For more information, see Troubleshooting.
  • Added freeform JSON query functionality for aggregate and list queries. You can specify a standard JSON query for Visier's Data Query API to retrieve results. For more information, see JSON query code samples.

1.2.0

December 13, 2023

  • List queries now fetches snapshot records for subject data.
  • Previously, grouping by two or more levels on a parent-child dimension could return an incorrect metric count if one of the members was missing a level; for example, grouping by Organization Hierarchy Levels 2 and 3, but the HR team does not have Level 3. We fixed this issue so that you can group by many levels and get the correct query results!

1.1.0

November 22, 2023

  • Added multi-metric query functionality.
  • Added capability to get data from earliest or latest date available.
  • If the Date field is empty, the connector now fetches from the latest date with data if Time Direction is BACKWARD, or from the earliest date with data if Time Direction is FORWARD.
  • Appended ID to property names for clearer identification.
  • Improved query performance to reduce wait time.
  • Updated our OAuth 2.0 Refresh Token flow. Now, each login should persist for 8 hours before requiring a re-authentication.
1.0.0 October 25, 2023
  • We added versioning to the connector. In the authentication dialog, you can now see your MEZ file version.
  • If your MEZ file is outdated, you will see a warning message to update to the latest MEZ file.
0.9.0 September 28, 2023
  • The Visier Data Connector dialog now only requires your tenant's vanity name and API key.
  • Metrics and dimensions that are not visible in Visier are also not visible in Power BI.
  • We now return the date an event occurred for event records.
  • We added support for reference dimensions where an event's primary object will now have available dimensions and properties.
  • Previously, some dates were long numerical values. Now, those dates are returned in a human-readable value.
0.8.0 August 18, 2023 First release.