1. Introduction
This manual provides full steps of setting up an auto-report generation job. Follow those steps, a certain list of users will receive the generated report via emails, in configured report format and defined content structure, at certain schedule.
2. Workflow Overview
Step 1: Navigate to Setting page, click on ‘Automation’ Tab, and then click on ‘Auto Report Setting’ Page.
Step 2: Navigate to the top section of the page (‘Project Report Automation Job’), click on ‘+New’ to create a new report automation job, and define the job name, description, job schedule, enable status, etc. Please refer to manual Project Report Automation Job above for detailed instructions.
Step 3: Tick the report automation job that just created, and then click on the tab ‘Automatic Report items’ to configure the report items.
Step 4: Click on ‘+New’ button to add existing instruments / station-groups into this report job and to be plotted into the report. Please refer to manual - Automatic Report Items above for detailed instructions. You may also use ‘Edit’, ‘Copy’ and ‘Delete’ functions to add/delete any report items.
Step 5: Navigate and click on ‘Automatic Report Distribution’ tab to configure the distribution list and corresponding notification message.
Step 6: Click on ‘+New’ to create a new distribution list. Please refer to manual - Automatic Report Distribution above for detailed instructions.
3. Example of a new Project Report Automation Job
Navigate to the top section of the page (‘Project Report Automation Job’), click on ‘+New’ to create a new report automation job.
Job Name is set as 4701 MHM I & M Report
→ This identifies the scheduled job.Job Description is set as Daily Survey Graphs
→ This describes the job’s purpose: generating daily graphs from survey data.Time Interval shows At 09:45 AM, only in January
→ The job is scheduled to run and generate the report daily at 9:45 AM, but only during January each year.Cron Expression is **45 9 * JAN ***
→ This is the technical format of the schedule: minute 45, hour 9, every day, in January.Disabled checkbox is unchecked
→ The job is active and will run as scheduled.
Example: Schedule the report to be generated every month, every day, at 14:00 pm:
4. Example of create an Automatic Report Item
Tick the report automation job that just created, and then click on the tab ‘Automatic Report items’ to configure the report items.
Click on ‘+New’ button to add existing instruments / station-groups into this report job and to be plotted into the report.
Instrument/Station-Group is set to Station Group
→ Indicates the type of data to be reported in this automation job.Station Type is set to Survey XYZ Group (LD-VD) (XYZG)
→ Specifies the type of station group to be reported in this automation job.Station-Group Report Setting is set to XYZ Lateral Vertical Displacements Group Report
→ Defines the report template or configuration used for this station group.Station-Group Name is set to MHM RW3 - OPRMHM-9019
→ Identifies the specific station group being reported on.Output Format is set to Pdf
→ The report will be generated in PDF format.Sections Included:
AlarmLimits: Includes threshold or limit values that trigger alarms.
Chart: Adds graphical representations of the data.
DataTable: Includes tabular data for detailed analysis.
LocationMap: Shows the geographical location of the stations.
RemarkSummary: Summarizes any remarks or comments related to the data.
Last number of Records (set to 4)
→ Limits the report to the most recent 4 data records.Last number of Hours (empty)
→ If filled, it would restrict the report to data from the last specified number of hours.From Date-Time (empty, with calendar icon)
→ Allows you to manually select the start date and time for the report data.→ Empty means no time period limit. Open to all time serious and combine with other type of time limit.
To Date-Time (empty, with calendar icon)
→ Allows you to manually select the end date and time for the report data.→ Empty means no time period limit. Open to all time serious and combine with other type of time limit.
Start Time
→ Used to specify the exact time when data retrieval should begin.
→ Empty means no limit is set.End Time
→ Used to specify the exact time when data retrieval should end.
→ Empty means no limit is set.Days not included in Data Period Count
→ Allows selection of specific days to exclude from the data period calculation (e.g., Monday, Tuesday).
→ Empty means no limit is set.
Number of Initial Records
→ Specifies how many of initial records to be included in the report data table.→ E.g. 6 means the report data table will contains the initial 6 readings.
Number of Initial Hours
→ Defines a time window (in hours) from the beginning of the dataset to include in the report data table.→ E.g. 1 means the report data table will include all the readings recorded in the first 1 hour of data reporting period.
Last number of Records
→ Define how many of latest records to be included in the report data table.→ E.g. 1 means the report data table will contains the latest 1 readings.
Last number of Hours
→ Specifies a time window (in hours) from the end of the dataset to include in the report data table.→ E.g. 2 means the report data table will include all the readings recorded in the last 2 hours of data reporting period.
Number of Initial Records and Last number of Records are the common 2 entries to be used, to control the display data rows in the report data table.
5. Example of create an Automatic Report Distribution
Tick the report automation job that just created, and then click on ‘Automatic Report Distribution’ tab. Click on ‘+New’ to create a new distribution list.
Distribution List (set to MHM Daily Report)
→ Specifies the group of recipients who will receive the email.Email Subject (set to 4701 MHM I & M Daily Report)
→ The subject line of the email, summarizing the content — a daily report for site 4701 concerning Inspection & Maintenance.Email Body Content (contains 4701 I & M Daily Report)
→ The main message of the email, which may include details or attachments related to the daily report. Formatting tools are available to style the content.
Email Remark (set to Survey/I&M team)
→ A short note.Email Signature
→ A customizable section for adding a formal sign-off.
→ Includes formatting tools (font, size, etc.) and can display a logo/image, representing the organization or project.Contact Numbers (set to Contact Survey / IM team)
→ Provides contact information or instructions on who to reach out to for queries related to the email.
Single Report Order:
→ All added report items will appear in this section.
→ Drag any item to switch order.
→ Each item generates a separate report, displayed in the order they appear — the first item’s report will be shown at the top.
Cover Sheet:
→ Configure any texts, images as cover sheet attached to the report generated file.
Attachments as Report Sections
Upload Button
→ Allows users to upload new files to be included as report sections.Left Section: "Select Attached Items as Report Sections"
→ Currently lists:4701_-_I&M_Notes.pdf4701_MHM_-_I&M_Report_Template.pdf
→ The above 2 files are available to select.
Right Section: "Selected Attachments as Report Sections"
→ Currently lists:4701_MHM_-_I&M_Report_Template.pdf(will appear first)4701_-_I&M_Notes.pdf(will appear second)
→ The above 2 attachments files are selected and will be included into report as a report section.
Sections Re-order in Binder as below:
Cover Sheet
→ This will be the first page of the report, likely containing introductory or summary information.4701_MHM_-_I&M_Report_Template.pdf
→ The first attached report file, appearing right after the cover sheet.4701_-_I&M_Notes.pdf
→ The second attached report file, following the template.Alarm Status
→ A section detailing any alarm conditions or threshold breaches.Monitoring Frequency
→ Information about how often data is collected or monitored.Instrument/Station-Group Reports
→ Detailed reports from specific instruments or station groups.
Attachments as report attachments
Upload Button
→ Allows users to upload new files to be included as report attachments.Left Section: "Select Attached Items as Report Sections"
→ Currently lists:4701_-_I&M_Notes.pdf4701_MHM_-_I&M_Report_Template.pdf
→ The above 2 files are available to select.
Right Section: "Selected Attachments as Report Sections"
→ Currently lists: empty.→ If any files are selected, they will be included as attachments to be sent together with report to recipients.
Include Alarm Status (checked)
→ Enables the inclusion of alarm status information in the report alarm status section.Include Instrument with Alarm Status NORMAL (unchecked)
→ If checked, instruments with a normal (non-alarming) status will be included in the report alarm status section.Include Instrument with Alarm which is Over Time Boundary Conditions (unchecked)
→ If checked, includes instruments whose alarms have exceeded a specified time boundary defined below.Alarm Time Boundary: Last Number of Hours (empty)
→ Allows you to define a time window (in hours) to filter alarms that occurred recently.→ E.g. 2 means to include alarms that triggered within 2 hours before the report generation time.
Alarm Time Boundary: Before this Date-Time (empty)
→ Lets you specify a cutoff date-time to include only alarms triggered before that point.→ E.g. 10/08/2025 5pm means to include alarms that triggered before 10/08/2025 5pm into the report alarm status section.
Example 1 - configure alarm trigger:
With the following settings, Alarm status section will be included in the generated report: all the monitoring data that exceeds the alarm limit and was recorded within 240hrs (10 days) will be reported.
Example 2 - configure alarm trigger:
With the following settings, Alarm status section will be included in the generated report: all monitoring data (either exceeds the alarm limit or in normal status) will be reported in all time periods (either recorded within the last 240 hrs, between current time to 01-02-2025 17:23, or outside the last 240hrs, or outside the period of current time and 01-02-2025 17:23)
Cover Sheet Enabled
→ When checked, a cover sheet will be included at the beginning of the report binder.→ Untick means cover sheet will not be included, even if configured.
Attach Report Binder PDF (max. size of 20mb)
→ If selected, the full report binder will be attached as a PDF file, with a size limit of 20 MB.Include Excel Link
→ Adds a link to download the report data in Excel format.Include PDF Link
→ Adds a link to download the report in PDF format.Include Binder Link
→ Adds a link to access the full report binder online or from a shared location.Disabled
→ If checked, this configuration will be inactive and not used in report generation.
6. Example of Auto-Report Viewing
The Auto-Report VIEW page provides an overview of the available reports for the project. Users can browse, filter, and download reports generated within a specified time range.
6.1 To view a generated report
Go to the “Auto-Report VIEW” section
→ In the left sidebar, locate and click on “Report Files VIEW” under the Auto-Report VIEW category.Set the Time Range
→ At the top of the main panel, choose a time filter (e.g., Last 24 hours) to find recent reports.
→ Click “Load” to refresh the list.Browse the Report Folders
→ Look for folders named like “AUTO-REPORT [date]” (e.g.,AUTO-REPORT 06-03-2025).
→ Click on a folder to expand and view its contents.View Individual Report Items
→ Folders will be classified based on category and different report item (each instrument / station-group)→ Inside each folder, you’ll see excels and PDFs (if applicable) for each report item.
→ These are typically named by instrument or report type (e.g.,CHART_C3_OP_OP_01_20250306_110132_096.pdf).Locate the Binder PDF
→ Scroll to the end of the folder contents to find the Binder PDF, which compiles all report sections.
→ This file usually has a name indicating it’s a full report binder.Open or Download Files
→ Click on any file to view it directly or download it for offline access.
→ You can download up to 300 reports at one time.
Example Report:
Charts:
Station Image:
Data Table:
6.2 To Download and Delete any existing report
Allows users to select one or more reports to download or delete.
Download: Select one or multiple generated reports, click on ‘Download’ to download all the selected files into your local device.
Delete: Select one or multiple generated reports, click on ‘Delete’ to delete all the selected files permanently from the system records.