Background
Last updated to reflect Synergy Sep26 (v26.20) functionality
Prerequisites
Your organisation is onboarded in Evo
Your organisation has Evo Mapping and Routing provisioned
Relevant user(s) in org have access to the Evo M&R 'app'
Background mapping
Get your OS Maps API key from internal GIS colleagues
Info - the 'OS Maps API' must be added to an API project in the OS Data Hub
This is required to enable background map visibility
Catchment (Boundary) Layers
You need to have your boundary layers (e.g. catchment areas) ready for upload.
Formats supported include:
.TAB (MapInfo TAB file)
.SHP (ESRI Shape file)
.ZIP (containing either above)
Each boundary layer requires these feature attributes as a minimum for field mapping:
Catchment Name
This is for display purposes in Evo M&R only
External Data column
This is the value as returned to client applications (e.g. Synergy) to identify the catchment area. It's usually the DfE code of the school(s).
Routing
Evo Mapping and Routing supports two ways of accepting routing layers:
OS Data Download
You need to provide the relevant Order numbers from the OS Data Hub
Your GIS colleagues make the order and provide the order numbers for Roads and Path data sets.
You should order:
OS Highways Roads AOI or RAMI AOI data for your area plus an applicable buffer
OS Highways Paths AOI data for your area plus an applicable buffer
Note - we don't yet support NGD data.
IMPORTANT - The 'OS Downloads API' must be added to the same API project in the OS Data Hub as used for mapping above – this is required by Evo when using the 'Get OS Data' option for road/path imports.
Bespoke roads/path layer upload
You can upload your own, bespoke, pre-merged road and footpath layer that contains the roads/paths you want to be used for routing purposes.
Pre-merged means that the roads and paths data has been merged into a single network layer, whereby the points at which paths 'join' to roads have been suitably broken and re-snapped to accommodate the path.
Formats supported for upload:
.TAB (MapInfo TAB file)
.SHP (ESRI Shape file)
.ZIP (containing either above)
As a minimum, the layer needs to contain these feature attributes which are required for field mapping:
ExternalID (required)
this must be a unique, non-blank value for every feature in the network, covering roads AND paths. This is most often the
TOIDvalue
Road Name (required)
Road Number (required)
Avoid Pattern (optional)
Note - When Evo uses the Routeware OS Highways Converter tool to merge Road and Path datasets, this field is calculated from the source data. We recommend reviewing documentation OS Highways > RouteWare converter for guidance on possible values.
Z-level From (optional)
This should be the 'startGradeSeparation' field if sourced from OS Highways data
Z-Level To (optional)
This should be the 'endGradeSeparation' field if sourced from OS Highways data
Enabling Mapping & Routing in Evo Transport
Base URL for Evo
https://preprod-maps-api.hsc.accessacloud.com – internal use only
https://staging-maps-api.hsc.accessacloud.com – internal use only
https://maps-api.hsc.accessacloud.com – customers only
API key
Generate this from Routing & Mapping > API keys
Make sure the API key is set to use the sliding expiry date
Use a different key per calling application (e.g. Transport or Admissions), just in case one affects the other
Enabling in Legacy Admissions
Ensure Synergy Mapping and Synergy Routing are licensed
Ensure Mapping Service Type param is set to Access Mapping
Ensure Routing Service Type is set to Access Routing
Add the following to System Manager > Options > Common > GIS > Access Mapping & Routing
API Base URL
https://preprod-maps-api.hsc.accessacloud.com – internal only
https://staging-maps-api.hsc.accessacloud.com – internal only
https://maps-api.hsc.accessacloud.com – customers only
Synergy Client must be able to access at least the API address above
API Key
Generate this from Routing & Mapping > API keys
Make sure the API key is set to use the sliding expiry date
Use a different key per calling application (e.g. Transport or Admissions), just in case one affects the other
Catchment Description import
Once catchment layers have been imported to Evo Mapping and Routing, use the System Manager > Access Mapping and Routing Layers screen to 'import' catchment area descriptions from the relevant boundary layer(s) in Evo.
