Reports Module Tutorial

Reports generation tutorial, create and test a text report

Reports → Tutorial | Concept | How-to Guide | Reference

1. Create a Simple Text Report

We'll create a shift report showing tank status.

1. Navigate to Reports → Forms
2. Click first row to add new form
3. Configure:
   • Name: ShiftReport
   • SaveFormat: Text
   • SaveFileName: C:/Reports/Shift.txt
4. Press Enter

2. Design Report Content

1. Go to Reports → Forms Editor
2. Double click ShiftReport 
3. Enter the report template below, then Save the report:

================================
    TANK FARM SHIFT REPORT
    Date: {Server.DateTimeInfo.Date}
    Time: {Server.DateTimeInfo.Time}
================================

TANK STATUS SUMMARY
-------------------
Tank 1:
  Level: {Tag.TankFarm/Tank1/Level} ft
  Temperature: {Tag.TankFarm/Tank1/Temp} °F
  Pressure: {Tag.TankFarm/Tank1/Pressure} PSI
  Status: {Tag.TankFarm/Tank1/Status}

Tank 2:
  Level: {Tag.TankFarm/Tank2/Level} ft
  Temperature: {Tag.TankFarm/Tank2/Temp} °F
  Pressure: {Tag.TankFarm/Tank2/Pressure} PSI
  Status: {Tag.TankFarm/Tank2/Status}

PRODUCTION METRICS
------------------
Total Volume: {Tag.TankFarm/Metrics/TotalVolume} gal
Flow Rate: {Tag.TankFarm/Metrics/FlowRate} gpm
Daily Production: {Tag.TankFarm/Metrics/DailyProduction} gal

================================
End of Report

3. Test Report Generation

1. Start runtime 
2. Open PropertyWatch
3. Go to List2 and type: Report.Form.ShiftReport.Save
4. Change the value from 0 to 1
5. Check the folder to see generated report

4. Schedule Automatic Reports

Create scheduled task for shift reports:

1. Go to Reports → Forms
2. Change the SaveTrigger to: Server.Hour
3. The report will be generated every hour once the solution is running.

5. Monitor Report Status

1. During runtime, open Reports → Reports Monitor
2. Verify report status:
   • Name: ShiftReport
   • LastStatus: 0
   • SavedFileName: Shows generated file path
3. Check for any errors in LastStatusMessage

In this section...