KPIUtil.exe Overview

KPIUtil.exe is a tool that allows users to connect to both a Microsoft® Office Business Scorecard Manager 2005 server and a Microsoft SQL Server™ 2005 Analysis Services server to do the following:

To run KPIUtil.exe, navigate to the folder where the KPIUtil.exe file is located and double-click the file. KPIUtil.exe uses the permissions of the user who opens the tool.

Information about KPIUtil.exe is presented in the following topics:

KPIUtil.exe Prerequisites

You can install KPIUtil.exe in a computer configuration that includes one or more computers. We recommend installing KPIUtil.exe on a separate computer from where you install Microsoft Office Business Scorecard Manager 2005 and Microsoft SQL Server 2005 Analysis Services.

The Business Scorecard Manager application and the SQL Server 2005 Analysis Services application function as either a source or a destination, depending on what type of KPIs you are generating. For example, if you are generating Business Scorecard Manager KPIs from SQL Server 2005 Analysis Services KPIs, SQL Server 2005 Analysis Services is the source application and Business Scorecard Manager is the destination application. If you are generating SQL Server 2005 Analysis Services KPIs from Business Scorecard Manager KPIs, Business Scorecard Manager becomes the source application and SQL Server 2005 Analysis Services becomes the destination application.

The following table provides descriptions of KPIUtil.exe and its supporting applications.

Application Description

KPIUtil.exe

Enables users to generate KPIs from a source server and then export them to a destination server.

Business Scorecard Manager

Hosts the Business Scorecard Manager server metadata, including all scorecard elements (KPIs, scorecards, data sources, indicators) and related permissions.

SQL Server 2005 Analysis Services

Hosts online analytical processing (OLAP) cubes in SQL Server Analysis Services and provides the data that is used to build SQL Server Analysis Services KPIs.

We recommend installing KPIUtil.exe on a client computer. The computer that hosts KPIUtil.exe must have the following installed:

Item Requirement

Operating system

Recommended:

Microsoft Windows® XP with Service Pack 2 (SP2)

Also supported:

Microsoft Windows® Server 2003 with Service Pack 1 (SP1)

Applications
  • Microsoft SQL Server 2005 workstation components, including:

    • Microsoft .NET Framework 2.0

    • Common Language Runtime 2.0

    • Analysis Management Objects

  • Microsoft Office Business Scorecard Builder 2005

    Note: Microsoft.PerformanceManagement.Scorecards.Client.dll is the specific component of Business Scorecard Builder that is required. This .dll file is included as part of the Microsoft Office Business Scorecard Manager server installation and also as part of the Business Scorecard Builder installation.

Export KPIs from Business Scorecard Manager to SQL Server 2005 Analysis Services

This section explains how to create Microsoft SQL Server 2005 Analysis Services KPIs that are based on your existing Microsoft Office Business Scorecard Manager KPIs.

Before you do this, consider the following:

To export KPIs from Business Scorecard Manager to SQL Server 2005 Analysis Services

  1. Browse to the folder that contains the KPIUtil.exe files.

  2. Double-click the KPIUtil.exe file.

    The KPIUtil.exe--New Configuration window opens.

  3. In the Business Scorecard Manager server box, type the path to the Business Scorecard Manager server. Use the following format:

    http://servername:port/PmService.asmx

  4. Click Test Connection to ensure that a connection to the Business Scorecard Manager server is established.

  5. In the Export direction list, select From Business Scorecard Manager KPI to SQL Server Analysis Services KPI.

  6. In the SQL Server 2005 Analysis Services server box, type the name of the SQL Server 2005 Analysis Services server. Use the following format:

    servername

    The SQL Server Analysis Services KPIs that are generated from Business Scorecard Manager KPIs will be saved to an Analysis Services cube on this server.

  7. In the Database name list, select the database on the SQL Server 2005 Analysis Services server that contains the Analysis Services cube where the KPIs that are generated will be stored.

  8. In the Cube name list, select the Analysis Services cube where you want to store the KPIs.

  9. Next to the Generate new KPIs based on list box, do one of the following:

    • Select the All existing KPIs check box to export all of the Business Scorecard Manager KPIs to the SQL Server 2005 Analysis Services server.

      All of these KPIs now appear in the Generate new KPIs based on list box.

      Note: Microsoft SQL Server 2005 contains only three and five-level indicators, and KPIUtil.exe supports only standard three and five-level indicators. Only KPIs associated with three and five-level indicators appear in the list of KPIs.

    • Select the Specific KPIs check box to export only specific Business Scorecard Manager KPIs to the SQL Server 2005 Analysis Services server. Then in the drop-down list that appears, select the check box for each Business Scorecard Manager KPI that you want to export. If an icon appears next to a check box, the associated KPI has not yet been published to the Business Scorecard Manager server. You must publish KPIs before you can export them.

      Note: KPI names that appear in the list in blue italic font are KPIs that have already been exported. Each time you run the tool, all of the KPIs that you selected are overwritten. If you run the tool more than once, clear the check box for any KPI that you do not want to overwrite.

  10. Do one of the following:

    • Click Generate to create the SQL Server 2005 Analysis Services KPIs in the Analysis Services cube that you specified in step 8.

    • Click Save Configuration to save the file.

      This configuration file is saved as an .xml file. You can open the saved configuration file in KPIUtil.exe at a later time, or you can use the saved configuration file to generate SQL Server 2005 Analysis Services KPIs from the command prompt as follows: KPIUtil.exe -f [ConfigurationFileName] -l [LogFileName].

      Note: The command cannot be run from the command prompt if there are spaces in the name of the configuration file.

Export KPIs from SQL Server 2005 Analysis Services to Business Scorecard Manager

This section explains how to create Microsoft Office Business Scorecard Manager 2005 KPIs that are based on your existing Microsoft SQL Server 2005 Analysis Services KPIs.

Before you do this, consider the following:

To export KPIs from SQL Server 2005 Analysis Services to Business Scorecard Manager

  1. Publish the sample indicators that are included with KPIUtil.exe to the Business Scorecard Manager server before you generate Business Scorecard Manager KPIs from SQL Server 2005 Analysis Services KPIs.

    For information about how to publish KPIs to the Business Scorecard Manager server, see Microsoft Office Business Scorecard Builder Help.

  2. Browse to the folder that contains the KPIUtil.exe files.

  3. Double-click the KPIUtil.exe file.

    The KPIUtil.exe--New Configuration window opens.

  4. In the Business Scorecard Manager server box, type the path to the Business Scorecard Manager server. Use the following format:

    http://servername:port/PmService.asmx

  5. Click Test Connection to ensure that a connection to the Business Scorecard Manager server is established.

  6. In the Export direction list, select From SQL Server Analysis Services KPI to Business Scorecard Manager KPI.

  7. In the SQL Server 2005 Analysis Services server box, type the name of the SQL Server 2005 Analysis Services server. Use the following format:

    servername

    This server must contain the KPIs that you want to export.

  8. In the Database name list, select the database that contains the SQL Server 2005 Analysis Services cube where the KPIs will be stored.

  9. In the Cube name list, select the SQL Server 2005 Analysis Services cube where you want to store the KPIs.

  10. Next to the Generate new KPIs based on list box, do one of the following:

    • Select the All existing KPIs check box to export all of the SQL Server 2005 Analysis Services KPIs from the cube that you specified in step 9.

      All of these KPIs now appear in the Generate new KPIs based on list box.

      Note: Microsoft SQL Server 2005 contains only three and five-level indicators, and KPIUtil.exe supports only standard three and five-level indicators. Only KPIs associated with three and five-level indicators appear in the list of KPIs.

    • Select the Specific KPIs check box to export only specific SQL Server 2005 Analysis Services KPIs from the cube that you specified in step 8. Then in the drop-down list that appears, select the check box for each Analysis Services KPI that you want to export.

      Note: KPI names that appear in the list in blue italic font are KPIs that have already been exported. Each time you run the tool, all of the KPIs that you selected are overwritten. If you run the tool more than once, clear the check box for any KPI that you do not want to overwrite.

  11. Under User Permissions for KPIs, Data Sources, and Indicators in the Reader permissions box, type the domain and alias of each user to whom you want to grant Read permissions for the KPIs and data sources that you are importing from Analysis Services and for the sample indicators that are included with KPIUtil.exe. Use the following format:

    domain\alias

  12. In the Editor permissions box, type the domain and alias of each user to whom you want to grant Editor permissions for the KPIs and data sources that you are importing from Analysis Services and for the sample indicators that are included with KPIUtil.exe. Use the following format:

    domain\alias

  13. Do one of the following:

    • Click Generate to create the Business Scorecard Manager KPIs.

    • Click Save Configuration to save the file.

      This configuration file is saved as an .xml file. You can open the saved configuration file in KPIUtil.exe at a later time, or you can use the saved file to generate Business Scorecard Manager KPIs from the command prompt as follows: KPIUtil.exe -f [ConfigurationFileName] -l [LogFileName].

      Note: The command cannot be run from the command prompt if there are spaces in the name of the configuration file.

Insert Newly Generated Business Scorecard Manager KPIs in a Workspace File

Complete the following procedure to add the newly generated Microsoft Office Business Scorecard Manager KPIs to a Microsoft Office Business Scorecard Builder workspace file.

To insert newly generated Business Scorecard Manager KPIs in a workspace file

  1. In Business Scorecard Builder, open the workspace file to which you want to add KPIs.

  2. In Workspace Browser, right-click KPIs, and then click Insert.

    The Select KPI dialog box opens.

  3. On the Item or the Details tab, click the KPI that you want to insert in the workspace file.

  4. Click OK, and then click Close to close the dialog box.

View Newly Generated Business Scorecard Manager KPI Properties

When Microsoft Office Business Scorecard Manager KPIs are generated from Microsoft SQL Server 2005 Analysis Services KPIs, an actual value and three target values (Goal and Status, Trend, and Weight) are created for each Business Scorecard Manager KPI. These values are displayed in Business Scorecard Builder when the new Business Scorecard Manager KPIs are inserted in a workspace file.

The Data Mappings pane of the KPI Actual Editor or Target Editor displays the following properties for the actual or target values:

The Thresholds pane of the Target Editor displays the banding settings for the status values of the associated KPI. It also displays the banding settings for trend values of the associated KPI. The scoring pattern for all target values is either Increasing is Better or Decreasing is Better, and the band-by method is always Stated Score (advanced).

Only three-level and five-level standard indicators are supported by KPIUtil.exe. When KPIs are exported from SQL Server 2005 Analysis Services to Business Scorecard Manager, the business logic behind the Business Scorecard Manager KPIs is sourced from the SQL Server 2005 Analysis Services KPIs based on the following boundaries for three-level indicators:

And the following boundaries for five-level indicators:

To view the display-only data mappings for an actual value

  1. In Workspace Browser, click a KPI that you generated from a SQL Server 2005 Analysis Services KPI.

    Note: The new KPI must exist in a workspace file before you can view its data mappings. For more information, see Insert Newly Generated Business Scorecard Manager KPIs in a Workspace File.

  2. In the right pane of the window, on the Definition tab, under Actual and Targets, right-click Actual, and then click Edit.

    The Actual Editor opens.

  3. In the navigation pane of the editor, click Data Mappings.

    In the right pane of the Actual Editor, the display-only properties (Data Mappings, Time Intelligence, and Advanced Formulas) for the actual value appear.

To view the display-only data mappings for a target value

  1. In Workspace Browser, click a KPI that you generated from a SQL Server 2005 Analysis Services KPI.

    Note: The new KPI must exist in a workspace file before you can view its data mappings. For more information, see Insert Newly Generated Business Scorecard Manager KPIs in a Workspace File.

  2. In the right pane of the window, on the Definition tab, under Actual and Targets, right-click Goal and Status, Trend, or Weight, and then click Edit.

    The Target Editor opens.

  3. In the navigation pane of the editor, click Data Mappings.

    In the right pane of the Target Editor, the display-only properties (Data Mappings, Time Intelligence, and Advanced Formulas) for the target value appear.

To view the display-only boundary values for a target value

  1. In Workspace Browser, click a KPI that you generated from a SQL Server 2005 Analysis Services KPI.

    Note: The new KPI must exist in a workspace file before you can view its boundary values. For more information, see Insert Newly Generated Business Scorecard Manager KPIs in a Workspace File.

  2. In the right pane of the window, on the Definition tab, under Actual and Targets, right-click Goal and Status, Trend, or Weight, and then click Edit.

    The Target Editor opens.

  3. In the navigation pane of the editor, click Thresholds.

    In the right pane of the Target Editor, the display-only boundary values for the target value appear.