Confirm map widget

The Confirm map widget allows for a map to be embedded onto a page, displaying layers of data from Confirm. The map also allows a url to be configured, and enabled for a map layer to allow for reporting an issue against an item on that data layer.

note

If you have not built a Jadu Homepage before, please refer to Homepages.

Once you have added the Confirm map widget to a Jadu Homepage, configure the settings.

• Title - add an optional title to be displayed above the map.
• Map centre - the coordinates (latitude & longitude) to centre the map on when it first loads, if the end user has not agreed to sharing their current location. If they agree to sharing their current location, the map will centre on their location.
• Zoom level - this zoom level to use when the map first loads, if the end user has not agreed to sharing their current location. If they agree to sharing their current location, the map will zoom in to a predefined level.
• Non-map reporting route message - allows configuration of some text to display above the map which provides the user with an alternate route to make their report if they are unable to use the map. A section of the text can be made into a link with the below URL(s) by wrapping it in square brackets.
• Non-map reporting route public URL - the url to present to public users.
  If using a Central Form URL, it advised that you append /start to the end of the form url to avoid an in-progress report for another location/asset being picked up. For example, if the form url is https://my.domain/xfp/form/123, use https://my.domain/xfp/form/123/start instead. Note: this feature requires at least Jadu Central version 1.2.
• Non-map reporting route internal URL - the url that is presented to staff users acting on behalf of public users. Where a Central Form is used, this is typically the "Internal form" view of the same form that the public use. This url is used in place of the Non-map reporting route public URL, when ?internal=true is appended to the homepage url.
• Map Key Position - whether the map key should show above or below the map.

If the map is to be used for reporting issues based on location (e.g. a pothole or an obstruction on a road/pavement), enable the Allow user to plot a point toggle. Doing so will make some extra settings available:

• User plotted point label - the label given to points plotted by users, this is used as the title of the popup bubble and map key, for the relevant map marker.
• Boundary datasource - select the Data Source (configured in Data Sources) which defines the boundary layer. This will prevent the end user plotting a point (and therefore raising an issue) outside of the area that the authority is responsible for. If no Data Source is selected, the user can plot a point anywhere on the map.
• Road/streets datasource - select the Data Source (configured in Data Sources) which defines road/street assets. This is used to determine information about the point that the user has plotted on the map, such as the Site Code and Asset ID, for use when raising an Enquiry. It can also be used to identify maintenance responsibility in order to prevent a user reporting an issue for a road maintained by another party. When the user plots a point, the information for the nearest road (based on its geometry) to the plotted point within 20m will be used.
• Form link text - the text to use when prompting a user to report the issue via the below form link.
• Form link URL - the url to a form which is used for reporting issues at a specific location.
  It advised that you append /start to the end of the form url to avoid an in-progress report for another location/asset being picked up. For example, if the form url is https://my.domain/xfp/form/123, use https://my.domain/xfp/form/123/start instead. Note: this feature requires at least Jadu Central version 1.2.
• Internal form link URL - the url to a form which is used by staff users for reporting issues at a specific location on behalf of public users, this is typically the "Internal form" view of the same form that the public use. This url is used in place of the Form link URL, when ?internal=true is appended to the homepage url.
• GOV.UK report it URL - if configured, and the user attempts to report an issue outside of the configured boundary, but within Great Britain, the user will be provided this link and the closest postcode to the location they selected, so that they can find the correct place to report the issue.
• Marker icon - select an icon to use for the map marker when the user plots a point. This setting will be disabled if an icon set is not configured.
• Marker background colour - input the hex code of the colour to use for the background of the map marker.
• Marker icon colour - select the colour to use for the marker icon. It is important to ensure that the colour you choose has sufficient colour contrast with the marker background colour, to meet accessibility guidelines. There are many online tools available to check this, such as https://webaim.org/resources/contrastchecker. If an icon set is not configured or no icon is chosen, an auto-generated number will be used in place of the icon, which will be displayed in the colour chosen here.
• Popup message - a short informational message to include in the popup bubble for points that the user plots.
• Map Load Delay - allows configuration of the number of milliseconds to wait before attempting to load more data, after the user has moved around the map.

If the map is to be used for reporting issues against fixed assets (e.g. street lights, gullies, bollards, etc), you need to add a data layer to the map to display these assets. Below the Layers table, click Add Layer. You will then be prompted to enter the following settings for this layer on the map:

• Select datasource - select the Data Source (configured in Data Sources) which defines the assets which you wish to display on the map.
• Marker icon - select an icon to use for the map marker representing the asset. This setting will be disabled if an icon set is not configured.
• Marker background colour - input the hex code of the colour to use for the background of the map marker.
• Marker icon colour - select the colour to use for the marker icon. It is important to ensure that the colour you choose has sufficient colour contrast with the marker background colour, to meet accessibility guidelines. There are many online tools available to check this, such as https://webaim.org/resources/contrastchecker. If an icon set is not configured or no icon is chosen, an auto-generated number will be used in place of the icon, which will be displayed in the colour chosen here.
• Data point label - enter a label to use for points in this data layer.
• Popup message - a short informational message to include in the popup bubble for points in this data layer.
• Data to display in popup - the options you see here will depend on the data made available by the Data Source. Select the fields which you want to be shown in the popup bubble when a marker from this layer is clicked.
• Enable form link - enable this toggle to allow reporting against assets, or subscribing to updates for existing issues, in this layer. If enabled, further settings become available:
  • Form link text - the text to use when directing the user to the form.
  • Form link URL - the url to a form.
    It advised that you append /start to the end of the form url to avoid an in-progress report for another location/asset being picked up. For example, if the form url is https://my.domain/xfp/form/123, use https://my.domain/xfp/form/123/start instead. Note: this feature requires at least Jadu Central version 1.2.
  • Internal form link URL - the url to a form which is used by staff users on behalf of public users, this is typically the "Internal form" view of the same form that the public use. This url is used in place of the Form link URL, when ?internal=true is appended to the homepage url.

Click Save Layer. You will see the layer appear in the summary table.

If required, you can add other asset layers to the map in the same way.

It is likely that you will want to display other data on the map, such as existing enquiries against the displayed assets, or planned works. These can be added as additional layers, following the steps above. If the data on the layer is purely informational, ensure that you leave the Enable form link toggle disabled.