416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Plugin Packager

Hide navigation
RSS
Modified on Fri, 17 May 2013 06:14 PM Categorized as Add-ons, Administration
Click to return to: Documentation | Installing and Administering Dundas Dashboard | Utilities


Overview

PluginPackager is a utility that is included with the Dundas Dashboard installation for packaging plug-ins. The Plugin Packager will create a single file (with a .plugin extension) which, after being installed, can be used by Dundas Dashboard.

By default, PluginPackager is installed to the following folder:

Program Files\Dundas Data Visualization Inc\Dundas Dashboard\{InstanceName}\SDK\Tools\PluginPackager\

Also included is a command-line version of the utility which you can find more information for here.

How to package a plug-in

  1. Open My Computer and navigate to the folder where PluginPackager is located.
  2. Double click PluginPackager.exe to start the program.
  3. From the main window you can create new plug-ins, open existing plug-ins, and save a plug-in after filling out the information in the various tabs.
  4. After filling out all the necessary information, click Save to save the plug-in somewhere on the computer (as a .plugin file).

PluginManager opening screen.

PluginManager opening screen.


Tip: You can also launch the Plugin Packager from your Programs menu by pointing to Dundas Data Visualization, Inc → Dundas Dashboard {version} → SDK → Plugin Packager.

General tab

The General tab contains all the all the meta-information about your plug-in. Below is list of all the fields on this tab along with its description:

  • Type - The type of plug-in. This will determine how Dundas Dashboard recognizes the plug-in when it is being loaded. Available options include:
    • DashboardControlPackage - If your plug-in is a custom control for example.
    • DashboardExport - If your plug-in is used for exporting data or images.
    • DataProviderClient - If your plug-in is a client-side data provider.
    • DataProviderServer - If your plug-in is a server-side data provider.
  • Plugin ID - The unique ID of the plug-in, represented as a GUID.
  • Version - The version of the plug-in. You can specify a major version number with format A.B (⪚ 3.0 or 4.0). Or, you can use the full version format A.B.C.D (⪚ 4.0.4.1).
  • Description - A description of the plug-in.
  • Copyright - Copyright information for the plug-in.

General tab of the Plugin Packager.

General tab of the Plugin Packager.


Files tab

On the Files tab is where all the required assemblies (DLLs) for your plug-in are listed. In most cases this will be just the single DLL that your plug-in uses. However, if you are using other assemblies (libraries) in your plug-in, you will need to include those DLLs as well.

  • Add - Add the file(s) required by your plug-in to the list.
  • Remove - Remove a file from the list.

Files tab of the Plugin Packager.

Files tab of the Plugin Packager.


Dependencies tab

On the Dependencies tab are all of the GUIDs of other plug-ins that this plug-in requires in order to function. This is useful if you are creating a plug-in that will work only when another plug-in is installed.

  • Add - Add the GUID of the other plug-in that your plug-in requires, to the list.
  • Remove - Remove a GUID from the list.

To find the GUID of other plug-ins, you can open those .plugin files in the PluginPackager and take note of the Plugin ID field.

Dependencies tab of the Plugin Packager.

Dependencies tab of the Plugin Packager.


Related topics


Click to return to: Documentation | Installing and Administering Dundas Dashboard | Utilities

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.