History Report

We have created a Create History Report Form that allows the user to search for points and create a job that will email a CSV file containing the points' history on a one-time, daily, weekly, or monthly basis.

How to use History Report

First the finHtmlReporting.pod file needs to be added to "fan" folder located within the "lib" folder of the FIN Stack folder directory. Contact support regarding the finHtmlReporting.pod.

The user must also set up email SMTP settings. As well as enabling the finHtmlReporting and html2pdf extensions.

The user will go in the Folio app

Then, once inside the app, the user will select the Tools option in the top menu bar.

Inside the drop-down menu, select the "Reports" option to proceed to the next menu.

Inside this second drop-down menu select the "Create History Report" option. This will bring up the "Create CSV History Report"

hisReport Settings Form

The following options will be available:

Title: This will be the title of the report so user can easily identify it. This title will become the name of the job and will be part of the file name.
Filter: Type in a axon query or use the Filter button to the right to select which points history should be gathered for.
Select a time frame: This combo box contains options for the history time span.
Select a user email: This combo box contains available users with emails to have the report sent to.
Send the report: This comb box contains options for when to generate the report.
Organize Columns: Checking this box will allow the user to organize the order of the columns of the history report.

Select a Time Frame

This combo box contains the following options:

Today: This will gather the history for the current day.
Yesterday: This will gather the history for the previous day.
Current X: This will gather the history of the current X, where X can be week, month, or year.
Previous X: This will gather the history of the previous X, where X can be week, month, or year.

Select a User Email

This combo box will contain all the emails of users.

Send the Report

This combo box will contain the following options:

Now: This will not create a job, but create the CSV file and email it, only.
Daily: This will create a job to be ran on a daily basis.
Weekly: This will create a job to be ran weekly. If the original job was created on a Tuesday, then the report will be created and emailed every Tuesday.
Monthly: This will create a job to be ran monthly. The report will be created and emailed every 1st of the month at 9:00 AM.

Organize Columns

After the user has filled out the "Create CSV History Report" form, if they have selected "Organize Columns" and clicked "Apply" the following form will appear:

This form will list all the points that will be included in the History Report and allow the user to change the order.

For an exact order, make sure no numbers repeat.
For a more general order, the user may repeat the same numbers and those points will be next to each other. For example, all the points given a 1 will appear first before those with 2 or greater.

Once the desired order is added, the user will click the "Apply" button and a job (or report, if "Now" was selected) will be created.

Additional Information

Edit or Delete Jobs

To edit or delete the job created, the user can go into the Job app.

The job can be identified by looking for the title given to the report.

File Location

All reports generated by History Report can be found by going to the io folder of the project. EX: C:/Program Files(x86)/FIN Stack/db/demo/io/CSV.

Each time a report is created it's naming scheme will be the title of the report followed by the date it was created. EX: My Report on 2015-10-20, My Report on 2015-11-20, ect.

Example Report

Below is an example of a history report. We called it "Example Report".