Introduction

MetriQ plugins are customized extensions that allow MetriQ to export timing data directly into a different non-related software packages. Each plugin is designed specifically to seamlessly work with a different vendor's software, allowing the flow of timing data out of MetriQ and into the target software.

Getting Started with Plugins

Plugin File Location: To use the plugin facility of MetriQ, make sure that you have the correct plugin type for your target software, and that the plugin is located in the correct directory. Typically this directory is called Plugins and can be found as a sub-directory of your MetriQ install. e.g. c:\MetriQ\Plugins. The installer for MetriQ will automatically add the plugin into this directory for you.

Plugin Name: The file extension of a plugin is .dll, and there is a different plugin for each software package that you wish to integrate to. When you install MetriQ, and you require integration into a different software suite, make sure that you install the correct MetriQ version with the plugin type that will suite your needs.

Visual Clues to a Plugin being Active: When MetriQ starts, a search for a new plugin is made. MetriQ will automatically pick the first plugin module found in the Plugins directory. MetriQ will then add an extra button to the toolbar at the top of MetriQ's main screen. This button is used to open the plugin's postmaster.

If the Plugin button is grayed and disabled, this suggests that the plugin has been correctly loaded but still requires configuration.

Setting up your Plugin: Each plugin will have its own requirements, most especially the location and access requirements to its database. To modify these parameters and to change how MetriQ loads the Plugin, familiarize yourself with the Plugin Options page.

Before You Begin -Importing Staff: If you click the Plugin button after installing MetriQ for the first time, you will get a message which says, "You are not a valid user". This is because MetriQ will only allow the plugin to open, if and only if you are are logged into MetriQ as a valid staff member of the target software package. This means that you will need to import the staff from your target software package.

How to Import Staff: To do this, open the Staff Administratin screen from the toolbar of the main MetriQ window. From the menu, select File/Import From and choose the name of the software package you wish to import from. You will be prompted with the following dialog.

"Should each member of staff be able to see ALL Folders within MetriQ or just the ones they themselves have created? Choose Yes to enable the See All option."

The See All option means that any folders created in MetriQ can be seen by all staff with the See All option enabled. If this option is disabled, a staff member can only see the folders she/he creates or is allocated to.

Once you have imported staff, use the File > Change User option from the main menu, and logon to MetriQ using your name as it appears in the target software package .

Postmaster: MetriQ is a timing software package, even when running with a plugin. However, interfacing with the target software is done using a small data posting window, aptly named the 'Postmaster'. Use the Postmaster to direct where in the target database you expect your timing data to be exported. MetriQ will take care of the reset, and as you would expect, keep its own timing record of when and what software packages you used and for how long.

Postmaster Control Panel: The Plugin Control Panel is where you actually commit to the changes requested using the Postmaster. Here, you can edit or delete time sheet records before you commit the data to the target software package. The Postmaster also allows you to view and search the history of all committed time sheet records for your self, for others on the network, across dates and for keyword searches in the Notes section.

Next: Postmaster

©Copyright 2004-2007 MetriQ Limited All Rights Reserved. MetriQ Software is Patent Pending

site map