Share via

How to: Install a Ribbon Extension

  • Article

Where you install an extension—locally or globally—depends on where the extension is in the development cycle. During development of the extension, you can install it locally without deploying it. Then, when you are ready to deploy the extension, you can install it globally so that it becomes part of the ClickOnce installation for PerformancePoint Dashboard Designer. For more information about ClickOnce deployment, see ClickOnce Deployment for Windows Forms Applications in the Microsoft .NET Framework Developer's Guide.

Prerequisites

Before you can deploy the extension, ensure you have met the following prerequisites:

  • You have an Authenticode digital certificate for signing the application and deployment manifests.

  • Your custom DLL and all assemblies that it references are signed and you have given them strong names. For information about how to sign an assembly with a strong name and how to create a public/private key pair, see How to: Create a Public/Private Key Pair.

To install a Ribbon extension during development

  1. Copy your DLL into the folder that contains your local PSCBuilder.exe. The default path is drive:\Program Files\Microsoft Office PerformancePoint Server\3.0\Monitoring\DesignerInstall\3.0.

  2. In the same folder, open the PSCBuilder.exe.config file.

  3. In the PSCBuilder.exe.config file, add keys for the class factories in your extensions by using the following format: <add key="[Class name]" value="[Namespace name.Class name], [DLL name]" />

    For example, if your extension uses the CustomPluginTemplateFactory class and CustomPluginFactory class, which are in the Extensions.Dashboard namespace in Microsoft.PerformancePoint.Scorecards.CustomPlugin.dll, add the following entries.

    • In the <ReportViewTemplateExtensions> section, add the following.

      <add key="CustomPluginTemplateFactory" value="Extensions.Dashboard.CustomPluginTemplateFactory,
    Microsoft.PerformancePoint.Scorecards.CustomPlugin" />

    • In the <ReportViewExtensions> section, add the following.

      <add key="CustomPluginFactory" value="Extensions.Dashboard.CustomPluginFactory,
    Microsoft.PerformancePoint.Scorecards.CustomPlugin" />

  4. Save and then close the file.

  5. In the same folder, double-click PSCBuilder.exe to open Dashboard Designer.

To install a Ribbon extension for deployment

  1. On the computer that is running PerformancePoint Monitoring Server, add your DLL and any assembly that it references to the global assembly cache.

  2. In the folder that contains the Dashboard Designer ClickOnce installation files, open the PSCBuilder.exe.config file. The default path is drive:\Program Files\Microsoft Office PerformancePoint Server\3.0\Monitoring\PPSMonitoring_1\DesignerInstall\3.0.

  3. In the PSCBuilder.exe.config file, add keys for the class factories in your extensions by using the following format: <add key="[Class name]" value="[Namespace name.Class name], [DLL name]" />

    For example, if your extension uses the CustomPluginTemplateFactory and CustomPluginFactory classes, which are in the Extensions.Dashboard namespace in Microsoft.PerformancePoint.Scorecards.CustomPlugin.dll, add the following entries.

    • In the <ReportViewTemplateExtensions> section, add the following.

      <add key="CustomPluginTemplateFactory" value="Extensions.Dashboard.CustomPluginTemplateFactory,
    Microsoft.PerformancePoint.Scorecards.CustomPlugin" />

    • In the <ReportViewExtensions> section, add the following.

      <add key="CustomPluginFactory" value="Extensions.Dashboard.CustomPluginFactory,
    Microsoft.PerformancePoint.Scorecards.CustomPlugin" />

  4. Save and then close the PSCBuilder.exe.config file.

  5. Rebuild and then sign the application manifest file, as follows:

    1. Copy your certificate file into the folder that contains Mage.exe. The default path is drive:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\Bin.

    2. Open a .NET Framework SDK command prompt.

    3. Call Mage.exe.

    4. Use the -Update command to add your DLL to the application manifest file.

    5. Use the -CertFile command to sign the certificate.

      The following example assumes that Monitoring Server is installed in the default location and that the name of your certificate file is Cert.pfx.

      mage –Update "C:\Program Files\Microsoft Office PerformancePoint Server\3.0\Monitoring\PPSMonitoring_1\DesignerInstall\3.0\PSCBuilder.exe.manifest"
    –FromDirectory "C:\Program Files\Microsoft Office PerformancePoint Server\3.0\Monitoring\PPSMonitoring_1\DesignerInstall\3.0" -CertFile Cert.pfx

      Ensure that the DesignerInstall folder contains only Dashboard Designer application files. For more information about using Mage.exe, see Manifest Generation and Editing Tool (Mage.exe).

  6. Rebuild and then sign the deployment manifest file, as follows:

    1. Open a .NET Framework SDK command prompt.

    2. Call Mage.exe.

    3. Use the -AppManifest command to add an application reference to PSCBuilder.exe.manifest file.

    4. Use the -CertFile command to sign the certificate.

      The following example assumes that Monitoring Server is installed in the default location and that the name of your certificate file is Cert.pfx.

      mage -Update "C:\Program Files\Microsoft Office PerformancePoint Server\3.0\Monitoring\PPSMonitoring_1\DesignerInstall\PSCBuilder.application"
    -AppManifest "C:\Program Files\Microsoft Office PerformancePoint Server\3.0\Monitoring\PPSMonitoring_1\DesignerInstall\3.0\PSCBuilder.exe.manifest" -CertFile Cert.pfx

      For more information about using Mage.exe, see Manifest Generation and Editing Tool (Mage.exe).

See Also

Other Resources

Ribbon Items