NextGen FSM

Define integration settings

To integrate a service and NextGen FSM in an external service matrix, configure company parameters.

Prerequisites

  • All communications with services occur over HTTPS for data security.

  • Ensure your subscription or API key is active and authorized for routing services.

Note: If the API key expires or is regenerated, the parameter in Next-Gen FSM must be updated to restore connectivity.

Limitations

Currently, there cannot be calls that reference both traditional and online matrices in the same request. For example: 

  • Resources may have different movement types, but they must all rely on either traditional or online matrices.

  • Matrices from both OverIT GISWare and a service cannot be on the same request.

  • A scheduling request can’t involve two different resources or teams that have both online and traditional matrices.

Add required company parameters

Important: Misconfigured or missing parameters will prevent the external service matrix from executing routing calls.

Base URL

To invoke routing and optimization APIs, specify the root URL for all service calls

  • Use property company.fsm.optimization.oss.serviceBaseUrl  as a base endpoint

  • Example: company.fsm.optimization.oss.serviceBaseUrl=https://api.service.io/routing

API Key

To access routing services, authorize and activate the service’s APIs in NextGen FSM

  • Use property company.fsm.optimization.oss.serviceApiKey to provide the required authentication token.

  • Example:company.fsm.optimization.oss.serviceApiKey=9f8a34b1-xxxx-xxxx-xxxx-bc92d04b8cde

Configure integration settings

  1. Navigate to Administration > Company Parameters.

  2. Add or edit the following parameters:

    • company.fsm.optimization.oss.solviceBaseUrl – enter the base URL of the service.

    • company.fsm.optimization.oss.solviceApiKey – enter the valid API key provided by the service.

  3. Click Save.