Skip to main content

Automatic Report Items

To add report items into created report automation job

Y
Written by Yuxi Liu
Updated over 3 weeks ago

1. Introduction

This manual is a sub-manual to introduce the Auto-Report Setting Page --> Automatic Report Items. This section allows users to configure the specific INSTRUMENT or STATION GROUPS that should be included in the automated report.

The Automatic Report Items can be accessed via:

  1. Click on the top left corner to open the setting side bar. Click on ‘Automation’ tab, and then click on ‘Auto-Report Settings’ sub tab to access the page.

  2. Click on an existing automation job row, the 'Automatic Report Items' section will appear at the bottom.


2. How to Add Auto-report Items

Add existing instruments and/or station-groups into the selected automation job, to plot its data into the report.

Step 1: Tick to select an existing automation job, and navigate to the ‘Automatic Report Items’ section.

Step 2: Click on ‘+New’ button to open a dialog and configure the new automatic report item.

In the pop-up dialog, fill in the following fields:

  • Instrument/Station-Group: Select whether the data source is based on an instrument or a station group.

  • Instrument / Station Type: Specifies the type of instrument / station-groups (e.g., monitoring/settlement).

  • Instrument / Station-Group Report Setting: Defines the plotting configuration for the selected instrument / station-group type.

  • Instrument / Station-Group Name: The name of the instrument / station-group associated with the data source. Select the specific instrument/ station group from the available options to plot its data.

  • Output Format: Choose the format(s) for the report (e.g., Excel, PDF, Excel and PDF). Specify how the report will be delivered to the recipients.

  • Sections Included: Select the data sections to include, such as Alarm Limits, Charts, Data Tables, Location Maps, Sketches, and Remarks. Use: Add or remove specific sections based on the report's purpose and audience.

Report Data Period Section

  • Last Number of Records: The most recent number of data records to include.

  • Last Number of Hours: The most recent hours of data to include. (E.g. “8760” for one year)

  • From Date-Time: Specify the start date and time for the data range to include in the report.

  • To Date-Time: Specify the end date and time for the data range to include in the report.

Time for Data Retrieval to Start and End Section

  • Start Time: The time of day when data retrieval begins. It is used to limit data to specific time windows within a day.

  • End Time: The time of day when data retrieval ends. It is used to limit data to specific time windows within a day.

  • Days Not Included in Data Period Count: Exclude certain days (e.g., weekends or holidays) from the reporting period. Select days to exclude, ensuring reports reflect only relevant working days.

Report Data Table Section

  • Number of Initial Records/Hours: Define an initial data range by specifying either a number of records or hours to include. For example, only take the initial 1000 records to be reported.

  • Last number of Records / Hours: Define a data range by specifying either the last number of records or hours to include. For example, only take the latest 10 records to be reported.

  • Disabled: Indicates whether this report item is active or inactive. Check the box to disable this report item temporarily.


3. How to Read the Automatic Report Items Table

  • Item Type: Specifies the type of data item being reported.

  • Sections Included: Indicates which sections of the report are included.

  • Instrument/Station-Group Name: Refers to the name of the instrument or group of stations providing the data.

  • Secondary Items: Additional data items related to the primary item type.

  • Output Format: Defines the format in which the report will be generated (e.g., CSV, PDF).

  • Enable: A toggle or status indicating whether the report configuration is active.

  • FROM DateTime (Report Data): The start date and time for the data being reported.

  • TO DateTime (Report Data): The end date and time for the data being reported.

  • Last number of Hours: Specifies a time window in hours for recent data.

  • Last number of Records: Limits the report to a specific number of the most recent records.


4. How to Edit/Copy/Delete existing Auto-report Items

Edit / copy / delete existing auto-report items by following steps:

Step 1: Tick to select an existing auto-report item.

Step 2: Click on ‘Edit’ to open the dialog and make any necessary changes; Click on ‘Copy’ to duplicate the existing item; Click on ‘Delete’ to delete the ticked auto-report item.

Step 3: Click on ‘Save’ to save any changes.

Did this answer your question?