Reporting

Configure Reports

The configure tab allows configuration of new reports and management of report templates. Configured reports are listed as per the below table. The report name, report template and layer upon which the report is based are visible here. Existing reports can also be edited and deleted here.

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.

After defining 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. New elements can now be added to build the report.

Add Report Elements

Report elements define the content you wish to include in a Report. Elements such as maps, tables and text can be added 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 the following map details to be configured:

• 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 currently 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 the following table details to be configured.

• 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 pre-configured 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 through 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, you 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 enabled. 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, you 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 text box 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, you will again be presented with fields to choose and then following spatial query details will be presented upon clicking “Continue”.

In this section, you can define the 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.

Database Queries

To add a table to a report based on a database query, click on the “Add element” dropdown and select “Table”. This will again open a table configuration panel on the right-hand side of the page. Fill this out with the table styling details. Under Table Source select Database. Next, click New Query.

The below “Data query” window will appear. This wizard will step you through setting up a data query.

The following query details can be configured:

• Query name – Name of the layer query
• Query type – This can be either a Table/View or a stored procedure
• Table\View\ Stored Procedure – the table, view or stored procedure in the database that you want to use in your table.
• Include Group by clause – Tick if would like to include a Group by clause eg. if the database table already has an aggregation field you may wish to use this count in your feature query clause. 
• Tick if you would like to include an Order by clause. This will define the queries are ordered in the table.

Define your Data query.

1. Query name – The title that will appear in the Table
2. Select – this box will be populated as you create your query from the table fields.
3. Fields – The fields you wish to display in the table

Reorder how the fields are presented in the popup by clicking the dotted icon and dragging the field to a new position.

Set the relationship parameters:

Review your clause and save the new Feature query. This will then be added to the main table.
Note, if you wish to change your configuration set up at any stage in the wizard, simply click on the dot symbol above each step to go back (as per the above image).

Add Text

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

Once complete, click "Save" to add the text element to the report. The text box should appear in the Text element.

Delete a report

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.

Assign to a map

One or several reports can be assigned to a webmap in LocalMaps. In the “Maps & Apps” page, under the “Reports” tab, configured reports can be chosen a from the drop down. A report will be available in the drop-down only if the report layer is present in the webmap chosen.

If the webmap does not contain a report layer the following message will be shown.

Report Fonts

This section allows the following details for a font style to be configured.

Add Font style

Click on the “Add style” button. Here a new style name, font family, size and style can be defined. By clicking the Font colour and background colour textboxes, a colour picker window appears from which a colour can be selected.

Edit Font style

To edit an existing font style, click on the “Edit” button in the row of the layer you wish to edit. The “Edit” window appears with details filled in the form. After making changes and clicking the “Save” button, the “Edit” window will close and the font style will adopt the changes.

Delete Font style

To delete a font style, simply click the corresponding “Delete” button of the style you wish to delete. This will remove the font from the list and it will no longer be an option to select from the font drop downs when adding a table or text element.

Report Queries

This section lists any report queries that have been configured for existing reports. To delete a report query, simply click the corresponding “Delete” button of the query you wish to delete.