-
Notifications
You must be signed in to change notification settings - Fork 77
Reports
Lucifer has two types of data saving systems. The most raw, unformatted is logs or logging. You can ask lucifer to save a log file of all the commands that go through the console to a file such as a .txt or .log file. The other system is through the LMI.Reports
Extension which allows for auto-generation of reports. At the current moment in time lucifer supports outputting the report in a nicely generated HTML file, which includes CSS and JavaScript to allow for a easily presentable report.
To enable command logging which tracks all commands that go through lucifer you need to run the the program with the logging argument active, example is python main.py -l myCommandOutput.txt
. The output file will contain the commands you have ran in the program.
These reports are auto-generated through the use of LMI.Reports
extension. They automatically include styling and JavaScript at the end of the file to allow for the easiest formatting of data. The data in these reports are in a table format which get placed in its own section once a table is generated in the lucifer program. To use this in lucifer you need to do the following:
-
Open a brand new report or open an existing one you would like to extend. To create a new one from scratch use the following command
report_new <fileName>
, note that the file name automatically gets.html
appended to the end if it is not already there. To open an existing report use the following commandreport_open <fileName>
. Also note that if the operation fails it will resort to the opposite command such that is it can not create a new file because it already exists it will open that instead and if it can not open the file because it does not exist it will create a new one instead. -
From here you have your file prepared, to make reporting active run
report_start
which will turn on report, from here any module or command what creates/generates a table in lucifer will be auto formatted onto the report. If you want to pause reporting you can doreport_stop
to freeze the reporting session, then you can restart it again withreport_start
.