Overview

The Site Report plugin for iShare GIS allows a user to create a Report detailing all of the Active layers enabled for Info Click in the current Map Window extents together with a map.

The following is a list of the current Plugins available for iShare GIS.

Setting the scene

You may wish to use the Site Report to report on the details of a New Development showing the Planning layers, TPOs etc. You would first select the relevant Layers, Zoom to the area you wish to report on and then click the Site Report button. This will then produce a report including a Map and attribute information for all visible Layers within the map window. Simply click the Print link to print the report to a printer of your choice or click Close to return to iShare GIS.

Map

Layers

Steps for enabling the “Site Report” button

Step 1 - Download the Plugin

Download the iShareGIS-SiteReport plugin.

Step 2 - Copy Plugin to custom\plugins folder

In order to prevent your custom plugins being lost when you upgrade your version of iShare GIS, they should be kept under the \web\custom\plugins folder. 

Create a SiteReport folder under this folder and add the downloaded SiteReport files e.g.

D:\Astun\iShareGIS\n.n\WebApps\Web\custom\plugins\SiteReport

Step 3 - Add to list of Plugins

Navigate up one folder level to the \custom\plugins folder. This folder must contain at least one XML file defining however many custom plugins are required. If this is the first plugin you are adding then you will need to create this file, otherwise you just need to add a new entry for the SiteReport plugin. The file should contain the following:

<PluginView>
  <Plugin>SiteReport</Plugin>
</PluginView>

For each custom plugin you would need to add a new <Plugin> entry. 

Save your changes.

Step 4 - Enable Plugin for a Map Source

In order for iShare GIS to load your custom plugins, you will need to manually add a PluginViews section, pointing to both the default iShareGIS.xml and your CustomPlugins.xml file, to any Map Source where you wish the plugins to be available as shown here.

<MapSource version="200" guid="012345678-9abc-def0-1234-56789abcdef">
  <Layers>
    ...
  </Layers>
  <PluginViews>
    <PluginView>plugins/iShareGIS</PluginView>
	<PluginView>custom/plugins/CustomPlugins</PluginView>
  </PluginViews>
</MapSource>

Save your changes.

Step 5 - Change Plugin button position - Optional

The default for the SiteReport plugin is to display the button on the right hand side of the toolbar. If you wish this to appear on the left you will need to edit the SiteReport.xml file and change the Category entry from "standard" to "advanced" e.g.

<Plugin>
	<Name>siteReport</Name>
	<Description>Activates the Site Report</Description>
	<Category>advanced</Category>
</Plugin>

Save your changes.

Step 6 - Change Plugin button Text & Tooltip - Optional

This step is only required if you wish to change the default text for the Button and Tooltip e.g.

Edit the SiteReport.js and scroll to the bottom of the file. If you want to change the Button label or Tool Tip for the button then you will need to change the text and tooltip  / tooltipTitle entries respectively.

Astun.JS.Plugins.installButton(
	{
		name: 'siteReport',
		type: 'modaldialog',
		dialog: Astun.JS.Plugins.dialogs.siteReportOutput,
		hideOnEmptyDialog: false,
		text: 'Site Report',
		tooltip: 'Activate the Site Report',
		tooltipTitle: 'Site Report'
	}
);

Save your changes.

Step 7 - Test the Plugin

The SiteReport plugin should now be configured.