ensembl-hive  2.1
 All Classes Namespaces Files Functions Pages
Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail Class Reference
+ Inheritance diagram for Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail:
+ Collaboration diagram for Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail:

Public Member Functions

public param_defaults ()
 
public fetch_input ()
 
public run ()
 
public write_output ()
 
- Public Member Functions inherited from Bio::EnsEMBL::Hive::Process
public new ()
 
public life_cycle ()
 
public say_with_header ()
 
public enter_status ()
 
public warning ()
 
public strict_hash_format ()
 
public param_defaults ()
 
public fetch_input ()
 
public run ()
 
public write_output ()
 
public Bio::EnsEMBL::Hive::Worker worker ()
 
public Boolean execute_writes ()
 
public
Bio::EnsEMBL::Hive::DBSQL::DBAdaptor 
db ()
 
public
Bio::EnsEMBL::Hive::DBSQL::DBConnection 
dbc ()
 
public
Bio::EnsEMBL::Hive::DBSQL::DBConnection 
data_dbc ()
 
public
Bio::EnsEMBL::Hive::AnalysisJob 
input_job ()
 
public input_id ()
 
public param ()
 
public param_required ()
 
public param_is_defined ()
 
public param_substitute ()
 
public dataflow_output_id ()
 
public throw ()
 
public complete_early ()
 
public Int debug ()
 
public worker_temp_directory ()
 
public worker_temp_directory_name ()
 
public cleanup_worker_temp_directory ()
 

Detailed Description

Synopsis

This is a RunnableDB module that implements Bio::EnsEMBL::Hive::Process interface
and is ran by Workers during the execution of eHive pipelines.
It is not generally supposed to be instantiated and used outside of this framework.
Please refer to Bio::EnsEMBL::Hive::Process documentation to understand the basics of the RunnableDB interface.
Please refer to Bio::EnsEMBL::Hive::PipeConfig::* pipeline configuration files to understand how to configure pipelines.

Description

    This RunnableDB module will send you a short notification email message per each job.
    You can either dataflow into it, or simply create standalone jobs.

    Note: this module depends heavily on the implementation of your compute farm.
    Sendmail may be unsupported, or supported differently.
    Please make sure it works as intended before using this module in complex pipelines.

Member Function Documentation

public Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail::fetch_input ( )
    Description : Implements fetch_input() interface method of Bio::EnsEMBL::Hive::Process that is used to read in parameters and load data.
                  Here we have nothing to do.
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail::param_defaults ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail::run ( )
    Description : Implements run() interface method of Bio::EnsEMBL::Hive::Process that is used to perform the main bulk of the job (minus input and output).
                  Here the actual sending of the email message happens in run() though one may argue it is technically 'output'.
    param('email'):   The email address to send the message to.
    param('subject'): The (optional) 'Subject:' line.
    param('text'):    Text of the email message. It will undergo parameter substitution.
    param('*'):       Any other parameters can be freely used for parameter substitution.
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail::write_output ( )
    Description : Implements write_output() interface method of Bio::EnsEMBL::Hive::Process that is used to deal with job's output after the execution.
                  Here we have nothing to do.
 
Code:
click to view

The documentation for this class was generated from the following file: