view release on metacpan or  search on metacpan

lib/CTM/ReadEM.pm  view on Meta::CPAN

Une reference vers un tableau d'ID ('serial') peut etre passee (mais PAS obligatoire, dans quel cas la methode s'appliquera au elements attaches a l'objet en parametre afin de filtrer les alertes a traiter.

Retourne 1 si l'operation a fonctionnee sinon 0.

=head3 $workOnExceptionAlerts->detete(\@array_ref_of_id)

Supprime la ou les alertes.

Une reference vers un tableau d'ID ('serial') peut etre passee (mais PAS obligatoire, dans quel cas la methode s'appliquera au elements attaches a l'objet en parametre afin de filtrer les alertes a traiter.

Retourne 1 si l'operation a fonctionnee sinon 0.

=head3 $workOnExceptionAlerts->setNote($note, \@array_ref_of_id)

La note d'une ou des alertes est egale a C<$note>.

    $workOnExceptionAlerts->setNote('Ces alertes sont prises en compte.');

Une reference vers un tableau d'ID ('serial') peut etre passee (mais PAS obligatoire, dans quel cas la methode s'appliquera au elements attaches a l'objet en parametre afin de filtrer les alertes a traiter.

Retourne 1 si l'operation a fonctionnee sinon 0.

=head2 $session->isSessionAlive()

Verifie et retourne l'etat de la connexion au SGBD.

B<ATTENTION>, n'est pas fiable pour tous les types de SGBD (pour plus de details, voir http://search.cpan.org/dist/DBI/DBI.pm#ping et les implementation de cette methode dans les drivers utilises par DBI (par exemple, http://search.cpan.org/~turnstep...

=head2 $session->isSessionSeemAlive()

Retourne l'etat (booleen) de la connexion a la base du Control-M EM telle qu'elle devrait etre.

=head1 PROPRIETES PUBLIQUES (C<CTM::ReadEM>)

=head2 $session->{DBMSType}

Type de SGBD du Control-M EM auquel se connecter.

Les valeurs acceptees sont "Pg", "Oracle", "mysql", "Sybase" et "ODBC". Pour une connexion a MS SQL Server, les drivers "Sybase" et "ODBC" fonctionnent.

=head2 $session->{DBMSAddress}

Adresse du SGBD du Control-M EM auquel se connecter.

=head2 $session->{DBMSPort}

Port du SGBD du Control-M EM auquel se connecter.

=head2 $session->{DBMSInstance}

Instance (ou base) du SGBD du Control-M EM auquel se connecter.

=head2 $session->{DBMSUser}

Utilisateur du SGBD du Control-M EM auquel se connecter.

=head2 $session->{DBMSPassword}

Mot de passe du SGBD du Control-M EM auquel se connecter.

=head2 $session->{$DBMSConnectTimeout}

Timeout (en seconde) de la tentavive de connexion au SGBD du Control-M EM.

La valeur 0 signifie qu aucun timeout ne sera applique.

B<ATTENTION>, cette propriete risque de ne pas fonctionner sous Windows (ou sur d'autres OS ne gerant pas les signaux UNIX).

=head2 $session->{verbose}

Active la verbose du module, affiche les requetes SQL executees sur STDERR.

Ce parametre accepte un booleen. Faux par defaut.

=head1 FONCTIONS PUBLIQUES (importables depuis C<CTM::ReadEM>)

=head2 getNbSession*()

=head3 getNbEMSessionsCreated()

Retourne le nombre d instances en cours pour le module C<CTM::ReadEM>.

=head3 getNbEMSessionsConnected()

Retourne le nombre d instances en cours et connectees a la base du Control-M EM pour le module C<CTM::ReadEM>.

=head2 ... liees a la generation ou au traduction d'informations en rapport avec BIM, GAS ou EA

=head3 getStatusColorForService() - (BIM)

Cette fonction permet de convertir le champ "status_to" de la table de hachage generee par la methode C<getCurrentBIMServices()> (et ses derives) en un statut lisible ("OK", "Completed OK", "Completed Late", "Warning", "Error").

Retourne 0 si la valeur du parametre fourni n'est pas reconnu.

=head3 getSeverityForAlarms() - (GAS)

Cette fonction permet de convertir le champ "status_to" de la table de hachage generee par la methode C<getAlarms()> (et ses derives) en un statut lisible ("Regular", "Urgent", "Very_Urgent").

Retourne 0 si la valeur du parametre fourni n'est pas reconnu.

=head3 getSeverityForExceptionAlerts() - (EA)

Cette fonction permet de convertir le champ "status_to" de la table de hachage generee par la methode C<getExceptionAlerts()> (et ses derives) en un statut lisible ("Warning", "Error", "Severe").

Retourne 0 si la valeur du parametre fourni n'est pas reconnu.

=head3 getExprForStatusColorForService() - (BIM)

Cette fonction converti les statuts "OK", "Completed OK", "Completed Late", "Warning", et "Error" (valeurs possibles en parametre) en une reference de fonction (pouvant notamment etre utilisee par les methodes keepItemsWithAnd() et keepItemsWithOr())...

Retourne une reference vers la fonction anonyme sub { shift =~ // } si le statut fourni est inconnu.

=head3 getExprForSeverityForAlarms() - (GAS)

Cette fonction converti les severites "Regular", "Urgent" et "Very_Urgent" (valeurs possibles en parametre) en une reference de fonction (pouvant notamment etre utilisee par les methodes keepItemsWithAnd() et keepItemsWithOr()).

Retourne une reference vers la fonction anonyme sub { shift =~ // } si la severite fourni est inconnu.

=head3 getExprForSeverityForExceptionAlerts() - (EA)

Cette fonction converti les severites "Warning", "Error" et "Severe" (valeurs possibles en parametre) en une reference de fonction (pouvant notamment etre utilisee par les methodes keepItemsWithAnd() et keepItemsWithOr()).

Retourne une reference vers la fonction anonyme sub { shift =~ // } si le severites fourni est inconnu.