Transport Settings

Overview

Transport Settings is the configuration document for the Transport module. It contains all system-wide settings for routing, telematics, carbon tracking, automation, and planning.

Configuration Sections

Automation

• Enable Auto Billing: Automatically create Sales Invoices when Transport Legs are completed
• Enable Auto Vehicle Assignment: Automatically assign vehicles to Transport Legs based on availability and compatibility

Routing

• Routing Provider:

  • Disabled
  • OSRM (Open Source Routing Machine)
  • Mapbox
  • Google

• OSRM Base URL: Base URL for OSRM server (default: https://router.project-osrm.org)

• Mapbox API Key: API key for Mapbox Directions API
• Google API Key: API key for Google Maps Directions API
• Default Avg Speed (KPH): Default average speed for calculations (default: 40)
• Routing Auto Compute: Automatically compute routes when addresses are entered
• Routing Show Map: Display route maps in Transport Legs
• Map Renderer:
  • OpenStreetMap
  • Google Maps
  • Mapbox
  • MapLibre
• Routing Tiles URL: URL for map tiles
• Routing Tiles Attr: Attribution for map tiles
• Routing Timeout (sec): Timeout for routing requests
• Maps Enable External Links: Enable external links in maps

Telematics

• Default Telematics Provider: Default provider for vehicle tracking
• Telematics Poll Interval (min): How often to poll for telematics updates

Carbon

• Carbon Autocompute: Automatically calculate carbon emissions
• Carbon Provider:
  • FACTORTABLE (use emission factors table)
  • CLIMATIQ
  • CARBONINTERFACE
  • CUSTOM_WEBHOOK
• Carbon Default Factor (g/km): Default emission factor per kilometer (default: 800)
• Carbon Default Factor (g/Tkm): Default emission factor per ton-kilometer (default: 62)
• Carbon Provider API Key: API key for carbon provider
• Carbon Provider URL: URL for custom webhook provider
• Emission Factors: Table of emission factors by vehicle type
  • Vehicle Type
  • Emission Factor (g/km)
  • Emission Factor (g/Tkm)

Transport Plan

• Forward Days in Transport Plan: Number of days to look ahead when planning
• Backward Days in Transport Plan: Number of days to look back when planning

Setup Instructions

Routing Setup

1. OSRM (Free, Open Source):

   • No API key required
   • Uses default OSRM server
   • Can use self-hosted OSRM server
   • Set OSRM Base URL if using custom server

2. Mapbox:

   • Get API key from Mapbox account
   • Enter API key in settings
   • Requires paid account for production use
   • Enable Directions API in Mapbox account

3. Google Maps:

   • Get API key from Google Cloud Console
   • Enable Directions API
   • Enter API key in settings
   • Requires paid account

Telematics Setup

1. Create Telematics Provider document
2. Configure provider settings
3. Set as default in Transport Settings
4. Configure poll interval based on needs

Carbon Setup

1. FACTOR_TABLE (Recommended):

   • Add emission factors to table
   • Configure by vehicle type
   • No external API required
   • Full control over factors

2. External Providers:

   • Get API key from provider
   • Enter API key in settings
   • Configure provider URL if needed
   • Test connection

Best Practices

1. Routing: Use OSRM for free routing, upgrade to Mapbox/Google for better accuracy
2. Telematics: Set appropriate poll interval based on needs (balance between accuracy and API costs)
3. Carbon: Use FACTOR_TABLE for control, external providers for accuracy
4. Automation: Enable auto-billing and vehicle assignment for efficiency
5. Planning: Set forward/backward days based on planning horizon

Related Documents

• Telematics Provider: Telematics configuration
• Transport Emission Factor: Emission factors table
• Vehicle Type: Vehicle type definitions

Notes

• Settings are system-wide and apply to all transport operations
• Changes take effect immediately
• API keys should be kept secure
• Test routing and telematics after configuration
• Review carbon calculations regularly
• Emission factors should be updated based on actual data