Configure scheduling service details for a new external service matrix

To use the external online matrix for scheduling services, define the XML configuration.

Define XML configurations

To view and define the XML:

1. Click the Routing Configuration tab. 

2. Select either of the following modes:

   • Guided Mode: For most users

   • Advanced Mode: For experienced users who need full control over the configuration.

Configure in guided mode

After you add details for a new external service matrix, the system automatically generates the XML code to invoke the GISware engine and the external service matrix. See Add details for a new external service matrix.

Configure in advanced mode

Important: For more directions, visit the external service provider’s documentation.

When you edit an online matrix, a pop-up window appears. In this window, you can modify the configuration NextGen FSM uses to integrate with the scheduling service. To do this:

1. Click Advanced Mode.

2. Do either of the following:

   • Start from scratch: Create a new XML configuration manually.

   • Click Start from a basic default configuration to load the default configuration from Guided Mode and modify it as needed.

3. Update the XML with the specifications and capabilities of the integrated external service. 

   • Include parameters or attributes, such as newly-released or beta features.

4. To ensure compatibility with the external service, check the XML syntax.

5. Click Save.  

Understand additional technical details

These metafields allow dynamic information to be added to the XML at run time:

• {{BASE_URL}}: The system substitutes with the value of the base URL defined in the company parameters.

• {{API_KEY}}: The system substitutes with the value of the API key defined in the company parameters. 

• {{OVERVIEW}}: To have a complete or more concise response on the route, the system substitutes with “full” or “false” .

• {{CACHE}}: The system substitutes with the cache used to resolve the problem.

• {{LOAD_CACHE}}: The system substitutes with the cache used to resolve the problem.

• {{SAVE_CACHE}}: The system substitutes with the cache used to resolve the problem.

• {{OVERWRITE_CACHE}}: To override the cache if it already exists when saving.

See Define integration settings.

Search path examples

The examples below show advanced XML configurations to configure the request to the searchPath service.

Example 1

<searchPath options="output.path.*">
<onLineRouting baseUrl="https://routing.solvice.io" name="onlineRouting" service="solvice"> <apiKey value="e7c0************d20d"/> <configuration overview="false" vehicleType="CAR"/> </onLineRouting>
	<problem>
		<vehicle prohibitions="true" cost="time" speeds="10,110,90,80,60,40,8,0" profiles="0,0,0,0,0,0,0,0" parkables="true,true,true,true,true,true,true,true"/>
		<point lat="46.984997261679766" lon="11.966755487639452"/>
		<point lat="38.03551980263659" lon="15.811073695135825"/>
	</problem>
</searchPath>

Example 2

<searchPath options="output.path.*">
<onLineRouting baseUrl="https://routing.solvice.io" name="onlineRouting" service="solvice"> <apiKey value="e7c0************d20d"/> <configuration overview="full" vehicleType="CAR"/> </onLineRouting> 
	<problem>
		<vehicle prohibitions="true" cost="time" speeds="10,110,90,80,60,40,8,0" profiles="0,0,0,0,0,0,0,0" parkables="true,true,true,true,true,true,true,true"/>
		<point lat="46.984997261679766" lon="11.966755487639452"/>
		<point lat="38.03551980263659" lon="15.811073695135825"/>
	</problem>
</searchPath>