Overview

The Feedback Report plugin for iShare GIS allows a user to provide Feedback in the form or an email using their default email client. The To, CC, Subject & Body may be auto populated.

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

Setting the scene

You may wish to use the Feedback button to allow users to report on any issues with access to data or even new layers they may like access to. One or more secondary buttons may be configured to allow users to provide different types of feedback to different email recipients.

Steps for enabling the “Feedback” button

Step 1 - Download the Plugin

Download the iShareGIS-Feedback 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 Feedback folder under this folder and add the downloaded Feedback files e.g.

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

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 Feedback plugin. The file should contain the following:

<PluginView>
  <Plugin>Feedback</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 Feedback plugin is to display the button on the left hand side of the toolbar. If you wish this to appear on the right you will need to edit the Feedback.xml file and change the Category entry from "advanced" to "standard" e.g.

<Plugin>
	<Name>Feedback</Name>
	<Description>Send email to support</Description>
	<Category>standard</Category>
</Plugin>

Save your changes.

Step 6 - Configure Feedback options

When you click on the Feedback button you may configure one or more secondary buttons for different types of Feedback e.g.

The Feedback plugin comes with two buttons configured as above and in the code below. These are configured in the Feedback.js e.g.

Astun.JS.Plugins.installDialog("feedbackDialog", function() {
	return {
		buttons: [
			{
				name: "",
				text: 'GIS Team',
				click: function() {
					var emailTo = 'gis@somecouncil.gov.uk';
					var emailCC = ' ';
					var emailSub = 'iShareGIS';
					var emailBody = 'Dear Sir/Madam';
					location.href = "mailto:"+emailTo+'?cc='+emailCC+'&subject='+emailSub+'&body='+emailBody;
				}
			},{
				name: "",
				text: 'Dave',
				click: function() {
					var emailTo = 'trigger@somecouncil.gov.uk';
					var emailCC = ' ';
					var emailSub = 'iShareGIS';
					var emailBody = 'Dear Sir';
					location.href = "mailto:"+emailTo+'?cc='+emailCC+'&subject='+emailSub+'&body='+emailBody;
				}
			}
		]
	};
});

 Each secondary button has its own configuration. If you wish to add more buttons simply add a comma and repeat the following entries changing the details for they type of Feedback you wish to configure.

{
				name: "",
				text: 'GIS Team',
				click: function() {
					var emailTo = 'gis@somecouncil.gov.uk';
					var emailCC = ' ';
					var emailSub = 'iShareGIS';
					var emailBody = 'Dear Sir/Madam';
					location.href = "mailto:"+emailTo+'?cc='+emailCC+'&subject='+emailSub+'&body='+emailBody;
				}
			}

Edit the Feedback.js and change any of the following entries for your secondary Feedback button(s):

Save your changes.

Step 7 - 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 Feedback.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: 'feedbackButton',
		type: 'quickdialog',
		dialog: Astun.JS.Plugins.dialogs.feedbackDialog,
		hideOnEmptyDialog: false,
		text: 'Feedback',
		tooltip: 'Use these email links to talk to support',
		tooltipTitle: 'Feedback'
	}
);

Save your changes.

Step 8 - Test the Plugin

The Feedback plugin should now be configured.