Users Guide

list_report_groups
Utilisation :
ompc_cli list_report_groups
La commande list_report_groups répertorie tous les groupes de rapports. Chaque groupe de rapports est
placé dans une ligne contenant les champs report_group_name, description et created_by.
list_reports
Utilisation :
ompc_cli list_reports [REPORT_GROUP]
La commande list_reports affiche la liste des rapports. REPORT_GROUP est le nom d’un groupe de
rapports. Si REPORT_GROUP n'est pas défini, tous les rapports sont répertoriés. Dans le cas contraire, seuls
les rapports appartenant au groupe de rapports REPORT_GROUP défini sont répertoriés.
Chaque rapport est placé sur une ligne contenant les champs report_name, description, format,
report_group_name, created_by et status (actifs ou non).
run_report
Utilisation :
ompc_cli run_report [-start_date <start_date>] [-end_date <end_date>] [-format
<CSV|XML>] [-file_name <file_name>] [-detail] REPORT_NAME
La commande run_report permet d'exécuter un rapport enregistré et d'exporter le résultat vers la
console ou un fichier.
Le paramètre REPORT_NAME est obligatoire et indique le rapport enregistré qui est exécuté.
Les options -start_date et -end_date sont facultatives : lorsqu’elles sont définies, elles sont utilisées
pour exécuter le rapport dans l’ordre de priorité de la période enregistrée avec le rapport d’origine. Si
uniquement -start_date est spécifié, l'heure actuelle est utilisée comme fin de la période. Si
uniquement -end_date est défini, l'heure la plus récente des données de surveillance est utilisée comme
début de période.
Si -file_name n’est pas défini, le résultat s’affiche dans la console dans le format CSV, en ignorant les
paramètres de formatage enregistrés avec le rapport ou spécifié par l'option -format.
Si -file_name est spécifié, le résultat est enregistré dans le format défini par l'option -format. Si
l'option
-format n'est pas définie, le format enregistré avec le rapport est utilisé.
L'option -detail ne s’applique qu'à un rapport « Puissance de réserve » pour exporter les informations
de calcul de l’alimentation délaissée.
Lorsqu'un rapport est exécuté, l’état du rapport est affiché dans la console ou enregistré dans un fichier
défini par <file_name>. Si l'exécution du rapport échoue, un message d’erreur s’affiche.
40