$Id: UsersGuide.xml,v 220.127.116.11 2005/05/05 20:18:59 msaffitz Exp $
Table of Contents
List of Examples
Plugins are small programs that work with the GUS application to load data. See the Developer's Guide for more information about the Plugin API and writing plugins. GUS comes with two types of plugins: Supported and Community. Supported plugins have been tested in both Oracle and Postgres and have been confirmed to work properly, are portable across any site with a standard GUS installation, and widely useful, and meet the plugin standard outlined in the Developer's Guide. Community plugins are provided as part of GUS as well, but they fail to meet at least one of these criteria and they should be reviewed prior to use.
GUS requires that all plugins be registered prior to use. This
allows for close auditing of the environment in which the plugin
operated and ensures that changes within a plugin do not go unnoticed.
When you attempt to use a plugin that has not been registered,
ga will respond with an error:
USER ERROR: GUS::Supported::Plugin::InsertControl has never been registered. Please use 'ga +create GUS::Supported::Plugin::InsertControl --commit'
You must then use the command provided to register the plugin. In this case:
$ ga +create GUS::Supported::Plugin::InsertControl --commit
If a plugin changes since being registered, you may receive a
similar error, requesting that you use the
Plugins are run using the
command with the full name of the plugin, as well as any command line
$ ga GUS::Supported::Plugin::
When you are ready to save the changes to the database, you must
--commit flag to the
$ ga GUS::Supported::Plugin::
GUS provides basic functionality for tracking changes and
controlling access by users, groups, and projects. To use this
functionality, you must first create User, Group, and Project entries in
the database. If you've just completed installing GUS, these will be
entered using the
dba user and group,
Database administration project
(these three values are the default in every GUS installation). These
tables are populated with either the LoadRow or LoadGusXml generic
plugins. Examples are below.
Example 2.1. Adding a User with LoadRow
ga GUS::Supported::Plugin::LoadRow --tablename Core::UserInfo --attrlist \ "login,password,first_name,last_name,e_mail" \ --valuelist jsmith^^^p@ss^^^Jane^^^Smithemail@example.com --commit
Example 2.2. Adding a Group with LoadRow
ga GUS::Supported::Plugin::LoadRow --tablename Core::GroupInfo \ --attrlist name --valuelist samplegroup --commit
Example 2.3. Adding a Project with LoadGusXml
The XML to load is shown above, and is assumed to be named
sampleproject.xml. The command to
load the XML is shown below.
<Core::ProjectInfo> <name>Sample project</name> <description>A sample project</description> </Core::ProjectInfo> //
ga GUS::Supported::Plugin::LoadGusXml --filename sampleproject.xml --commit
Once these tables have been populated, you must either update your
gus.config file (in the
$PROJECT_HOME/install/ directory), or
use the values from the command line when running plugins with the
GUS supports tracking third party databases and third party data
releases through the
These tables may be populated using the
The GUS Web Development Kit (WDK) provides a rich environment for rapidly creating query-centric websites. For more information on using the WDK, please see the online documentation
Plugins have several options for increasing the verbosity of log
messages. Add the
--help flag to the
end of your call to
ga to see options.
An active community of GUS users and developers is available on an informal basis to assist with using GUS. Posting to the GUS Mailing List or searching the archives is the fastest way to get assistance. When posting to the list, you should try to be as specific as possible, including the various command line arguments and full error messages, as appropriate. There are additional resources available on the GUS Website and GUS Wiki.