BeeWikiPlugin

The plugin to include "The BEE Project" OLAP reports into the TWiki pages. The Report is included using %BEE_REPORT% variable with a few parameters. The page-wide default parameters can be set by %BEE_PARAMS% variable optionally as well.

Syntax Rules

The %BEE_PARAMS{...}% sets the global (page-wide) parameters.

The %BEE_REPORT{...}% includes specific report into topic.

The %BEE_VALUE{...}% includes specific value into topic.

Parameter	Explanation	REPORT	VALUE	Default
DEFAULT	report or value identification
id
url	server url (osito) in form [http://]hostname[:port]			bee://osito
project	project name
user	user name			Osito user
lang	report language
skin	user interface skin ID
style	report CSS style URL (optional); if STYLE is not set then report's own CSS formating style will be used
padding	padding around the report			3px
hover	parameters of the line surrounding the report activated by onMouseOver in form "style,color,line_width"; parameters should be in consonance with CSS definition (e.g. style ca be 'dotted','dashed','double',...)			"solid,#ee0,3px"
interaction	Can be none, link, menu. none = only output, link = output with link to report, menu = with right click menu(only first reprot)	not menu		link
target	Open report in new window or in same window (_blank or _self)			_self
display	assumed size of report (it's only for view in wysiwyg editor)

Note: means parameter is required, represents optional parameter .

The %BEE_INFO{...}% includes some object or meta-data info into topic.

Parameter	Explanation	Required	Default
DEFAULT	type of the required information (see following table)
type
url	server url (osito) in form [http://][hostname][:port] or bee://[osito_root]		bee://osito if url is defined partially then default hostname is 'localhost', port is 80, osito_root is 'osito'
project	project name	(not required for project_list, optional for user)
user	user name		Osito user
lang	report language
id	ID of the object
format	output formating string (see following table)		'$name' for a scalar values ' * $name' for a lists
display	assumed size of report (it's only for view in wysiwyg editor)
string	select items by regular expression on the $name (Perl syntax)
folder	select objects from some folder
sort	Type of sorting (see following table)		id

Type	Substitution variables	Description	Implemented
user	$id	ID (login name) of the user
	$name	Name of the user
	$description	Description of the user
	$salutation	User's salutation
	$email or $email[N]	User's e-mail (first on N-th)
	$sms or $sms[N]	User's SMS No. (first on N-th)
	$fax or $fax[N]	User's Fax No. (first on N-th)
	$group_list	list of the groups user is involved in
	$role_list	list of the roles user is involved in (available only if project is specified)
project	$name	Name of the project
	$description	Description of the project
project_list	$id	ID of the project
	$name	Name of the project
	$description	Description of the project
OBJECT	$name	Name of the object ( OBJECT can be 'report', 'metric', 'filter', 'attr' or 'fact')
	$description	Description of the object
	$definition	Definition of the object
	$folder_path	Folder name with all path
OBJECT _list	$id	ID of the object
	$name	Name of the object
	$description	Description of the object
	$definition	Definition of the object
	$folder_path	Folder name with all path

Type of sorting

The %BEE_PROMPT{...}% includes specific prompts into topic.

Reports have to be with the same prompt. You have to checke off 'share among reports' and 'Selected values:' have to be 'set as default'.

In base usage type only %BEE_PROMPT{}%.

Note: Error will be raised if both 'id' and 'topic' will be set.

Examples

The Example of including two reports. We use BEE_PARAMS to set default url, skin, project and user. Each report has their own lang and id defined.

    %BEE_PARAMS{url="http://beedemo.insightstrategy.cz/bee2/" skin="cube" user="bee_en" project="BeeDemo"}%

    %BEE_REPORT{lang="en" id="aalQrKMgXde"}%

    %BEE_REPORT{lang="cz" id="aalQrKMgXde" skin="default"}%

BeeWikiPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %BEEWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Includes The BEE Project OLAP reports into TWiki pages.

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip BeeWikiPlugin.zip in your twiki installation directory. Content:

• Test if the installation was successful: You can add above mentioned example definition to the sample topic and test including of the reports from "The BEE Project" Internet Live Demo.

Note: In case you want to place BeeWiki.p password file in different than default directory let set its path in BeeWikiPlugin.pm.
Caution: Prevent public readability of the password file in any case.

FAQ

Plugin don't function and tests report fault "Error: Can't locate Error.pm in @INC" but @INC is good.

You don't have create link in lib directory to this module. Please create it. Example:
In TWiki home directory write

ln -s CPAN/lib/Error.pm lib/

Plugin Info

Plugin Author:	TWiki:Main.JanPrichystal, TWiki:Main.MichalDovrtel, TWiki:Main.VasekDovrtel
Copyright:	© 2005-2006, TWiki:Main.JanPrichystal, TWiki:Main.MichalDovrtel, TWiki:Main.VasekDovrtel
License:	GPL (GNU General Public License)
Plugin Version:	3.1
Change History:
12 May 2007	3.1: Added sorting and folder management
12 May 2007	3.0: BEE_PROMPT added, code rewrite
30 Aug 2006	2.1: BEE_VALUE, BEE_INFO added, code rewrite for compatibility vith TWiki v4 API
28 Jul 2005	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.024
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.6
Benchmarks:	GoodStyle nn%, FormattedSearch nn%, BeeWikiPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/BeeWikiPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/BeeWikiPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/BeeWikiPluginAppraisal

-- JanPrichystal - 28 Jul 2005

-- VasekDovrtel - 22 Sep 2006