Jens Rehsack > App-Report-Generator > App::Report::Generator::Command::GenReport

Download:
App-Report-Generator-0.002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.002   Source  

NAME ^

App::Report::Generator::Command::GenReport - provides the command class to run report configurations.

SYNOPSIS ^

This module is not intended to be used directly.

DESCRIPTION ^

This module provides a command class for App::Report::Generator to find configuration files loadable by Config::Any and run then via Report::Generator.

The configuration is searched in the configuration subdirectories genreport unless $ENV{APP_GENREPORT_CONFIGBASE} is set.

You can place the configuration at any location where configuration files could be expected, see File::ConfigDir for reasonable locations. Of course, test reports should be placed locally for the user (e.g. $ENV{HOME}/genreport/test-report1.yaml), reports which are planned to do periodically shall be placed at a location where the cron process could find it (/usr/local/etc/genreport/daily.yml or /opt/p5-genreport/etc/weekly.json).

Use genreport commands to figure out, which reports can be run.

FUNCTIONS/METHODS ^

command_names

Finds config files using File::ConfigDir (config_dirs), Config::Any (extensions) and File::Find::Rule. The searched depth is 1 - subdirectories aren't traversed.

set_action

Takes the user desired action (base name of the configuration file).

execute

Executes the report generation for the given report.

AUTHOR ^

Jens Rehsack, <rehsack at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-app-report-generator at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-Report-Generator. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc App::Report::Generator

You can also look for information at:

LICENSE AND COPYRIGHT ^

Copyright 2010 Jens Rehsack.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: