1. Introduction
The Instrument Report Settings page lets you define—and customize—the built-in reports available for each instrument type. You can:
Configure report titles, report headers with which logos to appear
Create or edit reports (Excel/PDF)
Configure which charts, data tables and layout sections appear in the report
2. Prerequisites
GeoSens user with Instrument-Admin or System-Admin role
Instrument types, data columns and chart settings already defined
3. Navigation
Log in to GeoSens.
In the left menu expand Instrument → click Report Settings.
4. Page Layout
4.1 Reports Settings Grid (Top)
The Instrument Report Settings define configuration for each report, including export options, linked Instrument report type, associated instrument types, and other display settings.
Column | Description |
Report Title | Name shown in the generated Reports (e.g. “Survey Settlement Report”). |
Instrument Report | Report type (e.g. |
Instrument Type | The instrument type this report summarized for (e.g. Survey Settlement Point (SSP)). |
Alarm Trigger Sets | Which alarm-threshold sets to include (select one or many). |
Enabled | ✓ to make the report available to end users; ✕ to hide it. |
Is Excel | ✓ if the report can be downloaded as an Excel file. |
Is PDF | ✓ if the report can be downloaded as a PDF. |
Notes | Free-text field for admin comments or version notes. |
4.2 Toolbar (Top-right)
Edit Grid: Click to enter inline-edit mode. Make changes directly in table cells.
View Grid: Exit inline-edit mode (read-only).
Edit: Click on an existing report row and click on 'Edit' to open the setting panel and make changes.
Save: In inline edit mode, click on save to save all changes.
Cancel: In inline edit mode, discard all un-saved edits.
5. Adding a new Report Job
Click on '+New' at the top-right corner function bar. A new report setting panel will appear at the right-side of the page.
Fill in all necessary fields and click on 'Create' to finish creation.
Field Name | Introduction | Example |
Instrument Report | Select the type of report to generate. | e.g., Tunnel Convergence LD-VD Report |
Instrument Type | Select the instrument type to be reported. Usually the instrument report type already defined certain available instrument types. | e.g., Optical Convergence Prism (CVO) |
Report Title | Enter a title for the report. | e.g., Tunnel Convergence LD-VD Report |
RPT Sheet Index | Specify the sheet index for the report (default: 1). | e.g., 1 |
Num Spaces Per Section | Define the number of spaces per section (default: 1). | e.g., 1 |
Direction | Choose report layout direction: Horizontal or Vertical. | e.g., Horizontal |
Orientation | Select page orientation: Portrait or Landscape. | e.g., Portrait |
Page Size | Choose page size for the report. | e.g., A4 |
Spaces to merge | Input specific spaces to merge in JSON format. Empty by-default. | e.g., |
Header Project Name? | Tick to include project name in the report header. |
|
To Include Category? | Tick to include instrument categories in the report. | e.g., Checked to show “Sensor Type” |
Project Logo | Upload or select a logo to display on the report. The available logos in the dropdown list can be added / edited in Images Management. | e.g., “geosens_logo.png” |
Project Contractor Logo | Upload or select a contractor logo for the report. The available logos in the dropdown list can be added / edited in Images Management. | e.g., “contractor_logo.jpg” |
Instrument Location | Specify the location of the instrument if necessary. | e.g., “Melbourne Site A” |
Header Info 1 | Add custom header information. | e.g., “Monitoring Period: July” |
Header Info 2 | Add additional header information. | e.g., “Client: ABC Engineering” |
Alarm Trigger Sets | Define alarm trigger settings for the report. | e.g., “Level > 50 dB” |
Notes | Add any notes or comments relevant to the report. | e.g., “Reviewed by team on 15 July” |
Is Excel? (Checkbox) | Tick to export the report in Excel format. | e.g., Checked for .xlsx output |
Is PDF? (Checkbox) | Tick to export the report in PDF format. | e.g., Checked for .pdf output |
Disabled (Checkbox) | Tick to disable this report configuration. | e.g., Unchecked (active) |
6. Editing an Existing Report Job
Enter Edit Mode
Click the 'Edit Grid' icon. The grid cells become editable. make changes directly in the table cells.
Alternatively, click on the existing report to be changed, and click on 'Edit' (pencil) icon to open the editing panel.
Save or Cancel
Save to commit all adds/edits/deletes.
Cancel to revert to the last saved state.
7. Report Detail Tabs (Bottom) - Charts
When you select a row in the Reports Grid, three tabs appear beneath it.
Charts Tab: Configure which chart(s) the report will render.
7.1 Charts Table Introduction
Column | Description |
Chart Settings | The chart template to include (e.g. “Settlement (mm) vs Time”). |
Section Index | The order in which this chart appears within the report. |
Enabled | ✓ to include this chart in the report. |
Notes | Chart-specific annotations or overrides. |
Updated By / On | Audit fields showing who last changed this setting and when. |
7.2 Edit grid
Click on 'Edit Grid' button at the top-right function bar. Toggle inline edit to add or modify chart entries.
7.3 Create filter
Build filters on any column (e.g. only see enabled charts).
7.4 To add a new chart setting
Click on 'Edit Grid' to enter editing mode.
Click on '+Add' to add a new chart setting. A new row will appear at the Report Charts data table.
Fill in the fields to configure the setting. The chart settings will be a dropdown list to choose available chart to be included in the report.
NOTE: Chart Settings dropdown list has been configured in Chart Setting Page. If further changes / creation needs to be made for chart settings, please refer to Instrument Chart Settings for instructions.
8. Report Detail Tabs (Bottom) - Data Tables
When you select a row in the Reports Grid, three tabs appear beneath it.
Data Tables: Configure which data tables and columns to include in the report, including column order, column displaying header, and visibility.
8.1 Data Table Introduction
Column | Description |
Report Table | Name of the report table category to be linked to this report (e.g. “Raw Readings Table”). |
Section Index | The section displaying order in the report. |
Enabled | ✓ to include this table in the report. |
Notes | Any table-specific comments. |
Updated By / On | The latest time and person that made the change. |
8.2 Edit grid
Click on 'Edit Grid' button at the top-right function bar. Toggle inline edit to add or modify chart entries.
8.3 Create filter
Build filters on any column (e.g. only see enabled charts).
8.4 To add a new chart setting
Click on 'Edit Grid' to enter editing mode.
Click on '+Add' to add a new data table. A new row will appear at the Report Data table.
Fill in the fields to configure the setting. The report table settings will be a dropdown list to choose available data table to be included in the report.
Add Remarks if necessary.
Click on 'Save' to save all the changes.
Click on the created report table row, an extra Data Column configuration table will appear at the bottom of the page.
At the bottom of the page in the Data Columns Table, click on '+Add' button at the top-right corner function bar, then a new row will appear in the Data Columns Table.
Fill in the necessary fields and click on 'Save' to finish the setting.
Field Name | Description | Example |
Report Column | The data column to be linked to this table. Click to select from the dropdown list. | e.g., “Lateral Displacement” |
Column Header | The header text displayed for the column in the report data table. | e.g., “Lateral Displacement (mm)” |
Column Index | The position or order index of the column in the data table. | e.g., 3 means place the Lateral Displacement column as the 3rd column in the data table to be included in the report. |
Data Format | The format in which data is displayed in the column. | e.g., “Number” or “Date” |
Null Text | Text to display when a cell has a null value. | e.g., “N/A” |
Enabled | Indicates whether the column is active in the report. | e.g., Checked (enabled) |
Alarm Color Off | Specifies if alarm coloring is disabled for this column. | e.g., Unchecked (active) |
Updated By | The user who last modified the column settings. This field will be filled by system. |
|
Updated On | The date and time of the last update. This field will be filled by system. | e.g., “2025-07-15 14:32” |
9. Report Detail Tabs (Bottom) - Sections
When you select a row in the Reports Grid, three tabs appear beneath it.
Sections: Configure whether to include the Location Map and Remark Summary in the report, and set their display order.
9.1 Section Index Table Introduction
Column | Description |
Section Name | Identifier for the report section (e.g. Location Map, or Remark Summary) |
Section Index | Determines the vertical displaying order in the final document. |
Enabled | ✓ to render this section. |
Notes | Guidance or content snippets for that section. |
Updated By / On | Who last edited and when. |
Tip: Use Section Index to control the order in which report sections appear. Charts, tables, and text sections are arranged based on their index values.
The Section Index applies across the Charts, Data Table, and Sections tabs. For example:
Charts section index = 1
Location Map section index = 2
Data Table section index = 3
The report will be generated in the order: Charts → Location Map → Data Table.
9.2 Add a new section
Click on 'Edit Grid' to enter editing mode.
Click on '+Add' to add a new section. A new row will appear at the Report Section Index table.
Fill in the fields to configure the setting. The report section setting will be a dropdown list to choose available report section to be included in the report. Location Map and Remark Summary are the 2 default sections available in the dropdown list.
Note: These sections (Location Map and Remark Summary) are preconfigured at the Geosens global level. To add new sections, please contact your global administrator.
10. Typical Exported Report to be expected
The purpose of this section is to help users understand the various sections in the report and what to expect.
10.1 For report exported in Excel format
Excel format can be used to view data in detail down to specific points.
10.2 For report exported in PDF format
PDF files can be used for formal reporting and formatting.
All the information of charts, data table, location map, tunnel sketch, remark summary will be shown on this page (if they are selected in the report setting page / subjected to different instrument types). In the headings, the information about instrument No., location, easting/northing, reporting period, alarm limits will appear.
11. Best Practices
Clear Titles: Make Report Title descriptive so end users can find it easily.
Enable Only What You Need: Un-check Is Excel or Is PDF if a format isn’t ready for release.
Alarm Sets: Assign only relevant alarm-trigger sets to minimize clutter.
Logical Ordering: Use Section Index to sequence charts, tables and narrative logically.
Audit Notes: Populate Notes fields so future admins understand why settings exist.