Everest icon

Everest

Interact with Everest TMS (Transport Management System)
Join our community

Actions55

Overview

This node integrates with the Everest Transport Management System (TMS) to manage routes. Specifically, the "Route - Create" operation allows users to create new delivery or service routes by specifying mission references and vehicles, along with various optional parameters such as route name, color, assigned agent, addresses, routing engine, scheduling constraints, and status information.

This node is beneficial in logistics, delivery services, or field service management scenarios where planning and assigning routes efficiently is critical. For example, a logistics manager can automate route creation for daily deliveries by providing mission IDs and vehicle assignments, optionally customizing route details like start/end addresses and time windows.

Properties

Name Meaning
Mission References Comma-separated list of mission reference IDs to include in the route (e.g., ABC123XXX,DEF456YYY). These represent the tasks or deliveries to be routed.
Vehicles Comma-separated list of platform vehicle IDs to assign to the route (e.g., 1,2,3). These specify which vehicles will execute the route.
Additional Fields A collection of optional fields to customize the route:
- Name: Name of the route (e.g., "Route du matin - Secteur Nord").
- Color: Route color in hex format (e.g., #FF5733).
- Agent: Agent assigned to the route (selectable).
- Agent Vehicle ID: Specific vehicle ID for the agent.
- Start Address: Starting address for the vehicle.
- End Address: Ending address for the vehicle.
- Router: Routing engine to use; options are Auto, Manual, VROOM, OSRM.
- Split Per Day: Boolean to split routes per day for multi-day planning.
- Early Departure: Boolean to allow early departure.
- Distribute Fairly: Boolean to distribute tasks fairly among vehicles.
- Status: Status to apply to all missions in the route (selectable).
Time Window Constraint Optional time window constraint specifying start and end date/time (Europe/Paris timezone) during which the route should be planned.
Status Extras Additional comma-separated status information strings to add extra context or metadata to the route status.

Output

The node outputs an array of JSON objects representing the created route(s). Each object contains details about the newly created route, including identifiers, assigned missions, vehicles, scheduling, and status information.

If binary data were involved (not indicated here), it would typically represent files or attachments related to the route, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with the Everest TMS API.
  • The node uses internal methods to load options dynamically for agents and statuses via API calls.
  • No additional external dependencies beyond the Everest TMS API.

Troubleshooting

  • Common Issues:

    • Invalid or missing mission references or vehicle IDs may cause the route creation to fail.
    • Incorrect date/time formats in the time window constraint could lead to errors.
    • Selecting an unsupported routing engine or invalid agent ID might cause API rejections.

  • Error Messages:

    • Errors returned from the Everest API will be propagated. Common messages might include "Invalid mission reference", "Vehicle not found", or "Unauthorized".
    • To resolve, verify that all required fields are correctly filled, IDs exist in the system, and the API credentials are valid.

  • Handling Failures:

    • The node supports continuing on failure if enabled, allowing partial processing of multiple inputs.

Links and References

Discussion