Create a Report
To add a report, click New above the Reports table. A New Report window will appear where you can fill in the following details:
- Report Name: The name of your report. This is what will be visible in viewer drop-down when a user generates a report.
- Template: Select a pre-configured report template to use. For more information on uploading and using these, see Report Templates.
- Report Layer: Select the layer you wish to base the report on i.e what the user will select and generate a report from.
On saving, a new report page will be created. New elements can now be added to build the report.
Add Maps
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 Add element .To add a map to a report, select Map from the drop-down. This will open the map configuration panel on the right-hand side of the page. In this panel, 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. A preview will then 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 drop-down 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. See below for details on each option.
Layer Queries
To create a new layer query for a table, click New Query. A Layer Query window will appear. The following query details can then be configured:
- Query name: Name of the layer query
- Layer query type: This can be either a query based on common attributes (Table Join) or spatial location (Spatial join). See below for details on each query option.
- Layer: the layer you want to display information from in the table
Table Join
If Table Join was selected as the layer query type, you can then set what fields will be displayed in the report. To include a field in the table, check the tick-box 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. Next, you can define the where clause upon which the join is based on. The Left drop-down defines what field in the query layer matches the report layer. The right drop-down, 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.
.
Spatial Join
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 drop-down 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. A Data query window will appear and the following query details can be configured:
- Datasource: The Database that contains the table you want to 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.
- Include Order by clause: This will define the queries are ordered in the table.
Click Continue to then define your Data query. Here, you can set the following:
- Query name: The title that will appear in the Table
- Select: this box will be populated as you create your query from the table fields.
- Fields: The fields you wish to display in the table
You can change the alias of fields by editing the appropriate text box. Fields can be reordered by clicking the dotted icon and dragging the field to a new position.
Next, define the where clause by selecting a common field from the drop-downs. Continue to review your clause and save the new Feature query. This will then be added to the main table.
Delete Report Queries
To delete any report queries that have been configured for existing reports, head to the Report Queries tab under Reporting. To delete a report query, click the corresponding Delete button on that row.
Add Text
To add a section of text to a report, click Add element and select text. This will open a text configuration panel on the right-hand side of the page. Choose the Font style, enter your text and then hit Save. The text element will then be added to the main table.
Delete a report
To delete a report, simply click the corresponding Delete button on the report row. Deletes will be confirmed by a green data update message box int he lower right corner. This will remove the report from the list.
Assign to a map
One or several reports can be assigned to a map in LocalMaps. In the Maps & Apps page, under the Reports tab, configured reports can be chosen from the drop down. A report will be available in the drop-down only if the report layer is present in the map chosen.
If the map does not contain a report layer the following message will be shown.
