Reporting

Report Templates

To start creating a report, a report template must first be added.

Click Manage Templates

To add a template, click on Add Template. Select a file to add as a template. The template that you upload could be:

1. Simple – a basic template authored in Microsoft Word. This could have your organisations banner, logo and disclaimer or it could be left blank. appendix for an example.
2. Dynamic – This type of report template is again authored in Microsoft Word but can include placeholders with specific syntax that the LocalMaps reporting engine understands. When you then generate a report, LocalMaps replace your placeholders with real values and you will get a nice printable document back.    appendix for an example.

Once successfully added, the template name will appear in the list of templates.

to delete a template, simply click the corresponding “Delete” button of the template you wish to delete. This will remove the template from the list and it will no longer be an option to select from the “Report Templates” drop down menu when adding a report.

Create a Report

To add a report, click on the “New” button above the Reports table. The below “New Report” window will appear displaying a form to fill.

The administrator can define the Report Name, select a report template to use from the drop down and the Report Layer from the dropdown. The report layer is what the report will be based on. On saving, a new report page will be created. Administrators can now begin to add new elements and build the report.

Report elements define the content you wish to include in a Report. Administrators can add elements such as maps, tables and text to a new report simply by clicking on the “Add element” button.

Add Maps

To add a map to a report, click on the “Add element” dropdown and select “Map”. This will open the following map configuration panel on the right-hand side of the page.

This section allows administrators to configure the following map details:

• Webmap – what webmap to add to the report. Once a webmap has been selected, a preview of the map will appear in the bottom preview box.
• Extent – Extent can be fixed or dynamic based on the selected feature
• Print template – The print template that will be used to create the map image.
• Layers – The right-hand side of the map will display the layers current turned on in the webmap. Expand the layers to turn on and off layers to include in the Map added to the report.

Click save to add the map to the report. Upon click, a preview will appear in the left-hand panel. This preview will include the Map name and Map thumbnail. Elements can be reordered by dragging and dropping to a new position in the list.

Add Tables

To add a table to a report, click on the “Add element” dropdown and select “Table”. This will open a table configuration panel on the right-hand side of the page. Tables added to a LocalMaps report can be either a Table Join or a Spatial Join based on a layer or database query.

This section allows administrators to configure the following table details.

• Table heading – this is the heading that will appear above the table.
• Table heading style – the style for the table heading.
• Table type – the table type can be vertical or horizontal. Vertical table type will have header fields across the top. The horizontal table type will have header fields down the left side.
• Show borders on table – Borders can be included or not included in the table.
• Table header style – the style for the table heading cells.
• Table cell style – the style for the table value cells.
• Table source – this defines what layer or database the data for the table will come from.
• Layer / Database queries – the layer or database query to use. Administrators can either set up a new layer query or use a preconfigured query if one has already been made.

Layer queries

To create a new layer query for a table, click the “New Query” button.

The below “Layer query” window will appear. This wizard will step you thought setting up a query layer.

The following query details can be configured:

• Query name – Name of the layer query
• Layer query type – This can be either a query based on common attributes (table query) or spatial location (Spatial join)
• Layer – the layer you want to display information from in the table

If a table join was selected as the layer query type, the following steps will be presented upon clicking “Continue”.

In this section, the administrator can set what fields will be displayed in the report. To include a field in the table, check the tickbox next to the applicable field. Number formats can be configured for number fields. If the number is currency this can also be enable. To rearrange the order of how the fields are displayed in the report, simply click and drag the field row to a new position.

Click “Continue” to move to the next step.

In this section, the administrator can define the where clause upon which the join is based on. The Left dropdown defines what field in the query layer matches the report layer. The right dropdown, defines the field in the report layer that matches the selected layer. The lower textbox identifies the Where clause based on the fields chosen. Once complete, click “finish” to save your new query layer.

If a spatial join was selected as the layer query type, administrators will again be presented with fields to choose and then following spatial query details will be presented upon clicking “Continue”.

In this section, the administrator can define following details:

• Spatial relationship – the spatial relationship to the report layer. Administrators can choose from Contains, envelope intersects, intersects, overlaps, touches or is within.
• Get intersected Area? Add a field to your table with a summary of the intersected area for a given feature eg Amount of Soil Type A in Parcel.
• Area Unit – Square Metres or Hectares
• Use buffer on report layer feature? You can choose to use a buffer with the spatial query created for the table.
• Buffer Distance – Distance set for buffer
• Buffer Units – Kilometre, Foot, Metre, Mile, Nautical Mile

Once complete, click “finish” to save the layer query. Upon click, a preview will appear in the left-hand panel. This preview will include the table name and a default table icon.

Add Text

Delete a report

Assign to a map