.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OutputJob 3pm" .TH OutputJob 3pm "2020-07-07" "Lire 2.1.1" "LogReport's Lire Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Lire::OutputJob \- Object used to represent a configured formatting of a report .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Lire::OutputJob; \& use Lire::OutputFormat; \& \& my $email = new Lire::OutputJob( \*(Aqemail\*(Aq, $output, $output_cfg, \& \*(Aqemails\*(Aq => [ \*(Aqemail@domain.org\*(Aq ] ); \& \& $email\->run( \*(Aqreport.xml\*(Aq ); \& \& my $file = new Lire::OutputJob( \*(Aqfile\*(Aq, $output, $output_cfg, \& \*(Aqfilename\*(Aq => \*(Aq/var/www/reports/daily\-%Y%m%d\*(Aq ); \& $file\->run( \*(Aqreport.xml\*(Aq ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Lire::OutputJob objects are used to represent how a report should formatted. These objects are most often created from the Lire configuration. (The 'output_jobs' specification.) .ie n .SH "new( $destination_type, $format, $format_cfg, ... );" .el .SH "new( \f(CW$destination_type\fP, \f(CW$format\fP, \f(CW$format_cfg\fP, ... );" .IX Header "new( $destination_type, $format, $format_cfg, ... );" Create a new Lire::OutputJob object. Two parameters are required: .ie n .IP "$destination_type" 4 .el .IP "\f(CW$destination_type\fR" 4 .IX Item "$destination_type" Can be either 'email' or 'file'. .ie n .IP "$format" 4 .el .IP "\f(CW$format\fR" 4 .IX Item "$format" A Lire::OutputFormat object. .ie n .IP "$format" 4 .el .IP "\f(CW$format\fR" 4 .IX Item "$format" The configuration data that will be passed to the OutputFormat object. .PP The method will returns an instance of Lire::EmailOutputJob or Lire::FileOutputJob. .SS "format" .IX Subsection "format" Returns the Lire::OutputFormat associated with this OutputJob. .SS "format_cfg" .IX Subsection "format_cfg" Returns the configuration data that will be used when formatting the report. .ie n .SS "run( $report_file )" .el .SS "run( \f(CW$report_file\fP )" .IX Subsection "run( $report_file )" Formats and sends or save the \s-1XML\s0 report \f(CW$report_file\fR according the OutputJob parameters. .SH "Lire::EmailOutputJob" .IX Header "Lire::EmailOutputJob" .SS "Extra parameters for 'email' type" .IX Subsection "Extra parameters for 'email' type" .IP "emails" 4 .IX Item "emails" An array reference to the emails that will receive the formatted report. .IP "subjet" 4 .IX Item "subjet" The subject of the email. .IP "extra_file" 4 .IX Item "extra_file" An additional text file that will be appended to text report or attach to other report types. .SS "\fBemails()\fP" .IX Subsection "emails()" Returns as an array the emails to which the report will be sent. .SS "\fBsubject()\fP" .IX Subsection "subject()" Returns the subject of the email. .SS "\fBextra_file()\fP" .IX Subsection "extra_file()" Returns the filename that will be appended to the text report or attach to the message for other report's type. .SH "Lire::FileOutputJob" .IX Header "Lire::FileOutputJob" .SS "Extra parameters for 'file' type." .IX Subsection "Extra parameters for 'file' type." .IP "file" 4 .IX Item "file" A file path with possible \fBstrftime\fR\|(3pm) interpolation. This will be were the formatted report will be saved. .SS "\fBfile()\fP" .IX Subsection "file()" Returns this OutputJob destination file. .SS "output_file( [$time] )" .IX Subsection "output_file( [$time] )" Returns the destination file with \fBstrftime\fR\|(3) specifier interpolated. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBLire::ReportJob\fR\|(3pm) \fBLire::OutputFormat\fR\|(3pm) .SH "AUTHOR" .IX Header "AUTHOR" .Vb 1 \& Francis J. Lacoste .Ve .SH "VERSION" .IX Header "VERSION" \&\f(CW$Id:\fR OutputJob.pm,v 1.8 2006/07/23 13:16:29 vanbaal Exp $ .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org .PP This file is part of Lire. .PP Lire is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program (see \s-1COPYING\s0); if not, check with http://www.gnu.org/copyleft/gpl.html.