Hyperpath configuration parameters
You can configure Hyperpath through a the text-based configuration file:
C:\optima \TDE\config-templates\CommandLineTDE.csv.
For information about the configuration file, see → Setting TDE parameters.

Hyperpath uses several datasources (→ General information on datasources):
- DS_MAIN
- DS_MODE
- DS_NETW
- DS_PARK
- DS_DVAL
- DS_FUNC
- DS_EXTE
- DS_TRAN
- DS_STRT
- DS_EVNT
- DS_STAT
- DS_BPER
- DS_CPER
- DS_TSTA
- DS_HTST
- DS_LKST
- DS_OPUT
- DS_ACNT
- DS_PATR_OPUT
- DS_MIDT

The Route choice section contains all the settings about route choice performed by users, for example in the assignment procedure or in routing path search.
Parameter | Type | Description |
---|---|---|
ATT_MAP |
String |
Attribute map of the attribute names in the database (field name) and the TDE internal names. The structure of the map is:
Do not use this map for the attributes that handle the information about the street hierarchy (HIER), speed (SPED), disabling (DISA), intersection time (ITIM), green share (GREN), and cycle time (CYCL). There are specific parameters for these. |
COEFlist |
String |
List of coefficients of cost attributes that have to be imported from the PREF table in addition to the standard fields. Usually this is done to enable customizable route choice because mode preferences are sensitive to these attributes. The list has comma-separated values. |
Default |
String |
Code of the default preference group used for preferences. Default: default |
LATTlist
Important: LATTlist must be considered DEPRECATED, starting from the version 19.5 (see → PTV Optima 19.5). Information associated to the → User Defined Attributes (UDAs) should be used instead. LATTlist IS NOT DEPRECATED ONLY for the configurations associated to TRE Add-In modules.
|
String |
List of the names of the custom attributes that have to be imported from the LINK table in addition to the standard fields. Usually this is needed to enable customizable route choice because mode preferences are sensitive to custom attributes (see → User Defined Attributes (UDAs)). The list is formatted as comma separated values. |
MALV |
Int32 |
Maximum hierarchy to include in the primary network. Streets that have a higher hierarchy are ignored. Default: 9 |
MCOE |
Double |
Maximum value that a coefficient may have. If any coefficient is greater than or equal to this value, it is considered infinite and the corresponding attribute yields infinite cost if greater than 0. Validity: ≥ 0 |
MILV |
Int32 |
Minimum hierarchy to include in the primary network. Streets that have a lower hierarchy are ignored. Default: 0 |
MSYS |
Int32 |
Maximum number of transport system types in preference coefficients. Default: 5 |
SATTlist
Important: SATTlist must be considered DEPRECATED, starting from the version 19.5 (see → What’s new?). Information associated to the → User Defined Attributes (UDAs) should be used instead. |
String |
List of the names of the custom attributes that have to be imported from the STRT table in addition to the standard fields. Usually this is needed to enable customizable route choice because mode preferences are sensitive to custom attributes (see → User Defined Attributes (UDAs)). The list is formatted as comma separated values. |
STUR_ATTlist
Important: STUR_ATTlist must be considered DEPRECATED, starting from the version 19.5 (see → What’s new?). Information associated to the → User Defined Attributes (UDAs) should be used instead. |
String |
List of the names of the custom attributes that have to be imported from the STUR table in addition to the standard fields. Usually this is needed to enable customizable route choice because mode preferences are sensitive to custom attributes (see → User Defined Attributes (UDAs)). The list is formatted as comma separated values. |

The Control section contains all the settings related to the control of the Hyperpath application.
Parameter | Type | Description |
---|---|---|
AppNameForIO | String | Application signature for IO data. This signature is often used as a suffix or prefix in IO files to identify the file owner. Also it is used to avoid workflow conflicts among different instances of the same software. |
showGUI | Int32 |
Data type: Integer Enables the Graphic User Interface (GUI).
Default value: 2 |
BKGM | Int32 | Control the running mode of the software.
Validity: [0, 2] |
DBUG | Int32 | Enables debug mode.
Validity: [0, 1] |
TDE_COUNTER | Boolean | Enables or disables the display of the progress of some possibly long steps during the import phase. (If enabled, the progress is displayed on the console.) Default: FALSE |

Parameter | Description |
---|---|
RUN_MODE | Run mode. Possible values are:
|
WebServiceAddress | Web address (URL) where Hyperpath is listening. Example: http://localhost:18000/dsps/vao/ The needed reservations to add (SQLite dependencies for the .NET Framework) are defined according to the value of this input variable. |
LANGlist | Available languages. Possible values are:
|
DS_LANS | Type and location of the source data for the project-specific language strings used in Hyperpath. |
FieldHIER | Name of the attribute used among input data to define the hierarchical level of the streets. |
MIES | Minimum speed for externalities function computation. Unit: km/h |
MAES | Maximum speed for externalities function computation. Unit: km/h |
NSPE | Name of the speed in the externality function. |
SSTE | Speed step for externalities pre-evaluation.
Unit: km/h |
MCOE | Maximum coefficient value. If a coefficient is greater than this value, the streets with the corresponding attribute are not excluded from the path solution. |
FieldSPED | Speed attribute field name. Specifies the name in the input date for the street attribute “speed”, which is a fundamental attribute for the computation process. For the mapped street attributes, consider the alias code. |
ESST | Interval between event search sessions. ≤ 0 = do not update event Unit: s |
TSTR | Interval between traffic state session updates. ≤ 0 = do not update traffic state Unit: s |
DSPE | Default speed for each street. Unit: m/s |
TimeIntervals FixedAPF |
Run precomputation of arc (fixed) cost. |
UpdateTime IndicesInAPF |
Update the label handling the index of the crossing instant respect to the standard periodization. |
AstarDistList | A* distance intervals.
Unit: m |
AstarDistValueList | A* values according to distance intervals. AstarDistValueList(i) is the value of the A* parameter for the request that has an estimated distance ∈ [ AstarDistList(i-1), AstarDistList(i) ]. nAstarDistValueList = nAstarDistList + 1 |
AstarModeDistList | A* distance intervals per mode. Overwrites the variable AstarDistList.
Format: modeCode_distValue Example: |
AstarModeDistValueList | A* values according to distance intervals and mode code. Overwrites the variable AstarDistValueList. AstarModeDistValueList(i) is the value of the A* parameter for the request that has an estimated distance ∈ [ AstarModeDistList(i-1), AstarModeDistList(i)]. nAstarModeDistValueList = nAstarModeDistList +1 For the distance intervals, the variable used is the variable AstarModeDistList if it includes the current mode. Else the variable used is the variable AstarDistList. Format: modeCode_astarValue Example: |
MinAstarLength | If the estimated path length is smaller than MinAstarLength, the A* parameter is set to MinAstar. Unit: m |
MaxAstarLength | If the estimated path length is greater than MaxAstarLength, the A* parameter is set to MaxAstar. Unit: m |
MinAstar | Minimum value for the A* parameter. |
MaxAstar | Maximum value for the A* parameter. |
DefaultAstarNMRequest | Default A* used for cost matrix requests. It is only considered if it is greater than or equal to 0. |
NumberOfClusters | Number of clusters to create to obtain some good heuristic. |
ClusterPrecomputation_ filePathInPut |
Path of the binary file that contains cluster precomputation information. If not specified, an automatic precomputation is performed. |
ClusterPrecomputation_ filePathOutPut |
Path of the binary file to which the cluster precomputation information is written. |
OnlyClusters | If TRUE, Hyperpath closes after cluster precomputation and export. |
ClusterRandomSeed | Seed used for cluster creation. |
ModeForClustersList | List of the mode code considered for the arc cluster cost precomputation. If empty and NumberOfClusters > 0, precomputation is performed for all modes. Format: comma-separated list |
ClusterPrecomputation_ ParallelThread |
Number of parallel processes used for cluster precomputation. |
CheckIfClusterData CanBeUsed |
If TRUE, for each incoming request Hyperpath checks whether the pref coef differs from the mode coef. If so, Hyperpath does not use cluster data. If cluster data is used, LabelCorrecting is forced to be TRUE. |
Cluster_euristicWeight | Weight of the intracluster parts of the heuristic. Validity: [0, 1] |
Cluster_betaParameter | Used to check whether cluster information can be used at runtime on a specific link. The condition used for the check is: d(gi−gj) ≥= b × (d(i−gi) + d(gj−j))
Validity: [1, ∞] |
OEXP | Only export the imported data sources. |
ESST | Interval between each event search session. ≤ 0 = do not update the event (evnt) Unit: s |
UTST |
Interval between each update travel time session ≤ 0 = do not update the current performance (cdyn) Unit: s |
MIDR |
Interval between mid-term forecast data update sessions. ≤ 0 = do not update mid-term forecast data Unit: s |
TSTR | Interval between update-observed performance sessions. ≤ 0 = do not update the observed performance (tsta) Unit: s |
PUTR | Interval between put real-time update sessions. ≤ 0 = do not update and do not import for the first time Unit: s |
MAX_PEND | Maximum admitted slope built in the network. Unit: % |
XML_DEBUG | If TRUE, Hyperpath writes the debug variables, such as the shortest path solving time, to the XML file. |
UTUR | By default permit U-turns.
|
PEDT | Force pedestrian turns. If TRUE, the transport system “pedestrian” can make any turn. |
ANGS | Consider geometric street attributes (turn angle, tortuosity, gradient). |
EXCT | Consider externalities. |
SNET | Show the imported network in a separate windows form. |
NPTH | Number of parallel solving thread. |
NTSP | Number of concurrent searching thread within the shortest path method. |
OrderIntraBucket | Extract the streets from the buckets in order of priority. Good value = True with LABC = False, not relevant otherwise. |
LabelCorrecting | Admit label correcting. Forced to TRUE if cluster data is used. Typically, setting this the value to FALSE is a good choice, but if you do not admit backward jumps, setting LabelCorrecting to TRUE can guarantee the optimality of the solution even if OrderIntraBucket is FALSE. |
LabelCorrectingMode DistList |
Label correcting distance intervals per mode. If not specified for a mode, the variable LabelCorrecting is used. Format: modeCode_distValue modeCode_Inf --> it exists only one range from 0 to Inf for the mode with code modeCode. Unit: m |
LabelCorrectingMode DistValueList |
LabelCorrecting values according to distance intervals and mode code.
Overwrites the variable AstarDistValueList. AstarModeDistValueList(i) is the value of the A* parameter for the request that has an estimated distance ∈ [ AstarModeDistList(i-1), AstarModeDistList(i) ] . nAstarModeDistValueList = nAstarModeDistList + 1 For the distance intervals, the variable used is the variable AstarModeDistList if it includes the current mode. Else the variable used is the variable AstarDistList. Format: modeCode_astarValue |
SMALL_ANG | Maximum value for a small turn angle. If x ≤ SMALL_ANG, x is considered to be a small angle. Unit: deg |
LARGE_ANG |
Minimum value for a large turn angle. If x ≥ LARGE_ANG, x is considered to be a large angle. Unit: deg |
DRGT | Additional delay for right turns. Considered only for large angles. Unit: s |
DLFT | Additional delay for left turns. Considered only for large angles. Unit: s |
MOAD | Minimum distance between an origin point and its foot. Used to create the “origin” action. |
MOAO | Minimum distance between a destination point and its foot. Used to create the “arrival on” action. |
fRDBT_street | Name of the roundabout attribute for streets. |
fRDBT_links | Name of the roundabout attribute for links. |
fDVDR | Name of the divider attribute. |
fRAMP | Name of the ramp attribute. |
PuTCOESlist | Coefficients used for public transport journey. Format: set of comma-separated fields |
PrTPuTCOESlist | Coefficients used for both private and public transport journey. Format: set of comma-separated fields |
MaxPermittedDirPoly | Maximum number of street arcs in the first and last valid street arc or link search. |
TimeMultiplier | Multiplier of the time t from the origin / destination to the first available street arc. The search is stopped if: t − t' > t * TimeMultiplier |
MaxDistance AvailableSarc |
Maximum distance for the search of the available street arc if there is a denied zone. Unit: m |
MTRT | Maximum street travel time. Unit: s |
map_center_lon | Center longitude to send to the client. |
map_center_lat | Center latitude to send to the client. |
map_proj | Map projection to send to the client. |
map_proj_display | Map displayed projection to send to the client. |
map_center_zoom | Map zoom initial level. |
TNSS | Transit network support speed. Unit: km/h |
MWAI | Maximum waiting time for a route of the hyper arc. Discriminates the insertion of a route into the hyper arc. Unit: s |
MAX_DIST_CONN_TS_TS | Maximum distance for implicit stop connections between “transit stop” – “transit stop”. Unit: m |
MAX_DIST_CONN_TS_PL | Maximum distance for implicit connections between “transit stop” – “pedestrian link”. Unit: m |
MAX_DIST_CONN_ACCESS_ EGRESS |
Maximum distance for implicit connections between “origin / destination” – “transit stop”. Unit: m |
MAX_DIST_CONN_PK_PL | Maximum distance for implicit connections between “origin / destination” – “transit stop”. Unit: m |
MAX_DIST_CONN_PK_TS | Maximum distance for implicit connections between “parking” – “pedestrian link”. Unit: m |
MIN_DIST_CONN_ DESCRIPTION |
Maximum distance for implicit connections between “parking” – “transit stop”. Unit: m |
MAX_OTDC_DISTANCE_ SEARCH_STOP |
Maximum distance during stop search around a given point. Unit: m |
MAX_PUT_DAYS | Maximum number of days of the PuT general calendar.
|
MHYL | Maximum number of common lines group contained in the hyper arc. |
HMIN | Maximum number of common lines group contained in the hyper arc. |
HMAX | Maximum headway used if at a stop there is no such available run of a route. Unit: s |
SKEB | Minimum time to wait at the stop of a schedule-based line. 0 = no waiting time Unit: s |
FSAR | Street arc filter. The graph is built on the street arc that has passed this filter. The structure of the filter is “FilterType_Condition”. Filter type can be:
The condition structure is “attribute operator value”.
The elements of each filter are separated by an underscore: “_” Example: O tunn > 0,O brdg > 0,A urdn > 0,A sped > 0 (Considers all the active (sped > 0) tunnels and bridges in an urban area.) |
FLNK | Link Filter. The graph is built on the sarc that passed this filter. The structure of the filter is “FilterType_Condition”. Filter type can be:
The condition structure is “attribute operator value”.
The elements of each filter are separated by an underscore: “_” Example: (Considers all the active (sped > 0) tunnels and bridges an urban area.) |
DefaultPrivate ModeCode |
Code of the default private mode. |
DeniedAttributes ForModes |
Code cost attributes used to deny turns for a given mode. Used to count the roundabout exit number.
Example: (Considers all alias code.) |
FirstModeList | Codes of the first available modes for the park & ride functionality. |
SecondModeList | Codes of the second available modes for the park & ride functionality. |
COESlist | List of coefficients to send to the client (case sensitive). For the mapped street attributes, consider the alias code. |
ATRSlist | List of cost attributes to send to the client (case sensitive). For the mapped street attributes consider the alias code. |
CATRlist | List of changeable attributes. For each link element of the response XML, there is defined a list that contains the values of the changeable attributes. If the value of one of the changeable attributes differs between the current link and the next link of the path result, this attribute is included in the list of the link XML element. Its new value is given. The elements of this list must be contained in SATTlist. If an element of CATRlist is included in the street attributes map (ATTmap), the alias value must be used. |
doExportPath RequestData |
If TRUE, the path request is exported according to the data source DS_PATR_OPUT. |
timeInterval ToDeletePatr |
When the maximum number of records in the PATR table has been reached, all records that are older than timeIntervalToDeletePatr are deleted from the table. Unit: s |
maxNumberOf RecordInPatr |
When the maximum number of the stored path responses has been reached on the specified database (DS_PATR), the software automatically deletes the content of the table used for logging the path request (at the next day change). |
NumberOf HyperpathRunning |
Number of concurrent Hyperpath that are running. |
HyperpathIndex | Index of the current software in the set Hyperpath that are running, starting from 1. |
Consider1NSpeedUp | If TRUE, Hyperpath uses the fast method for solving 1:N routing. |
RequestTimeout_ constant |
The timeout for the shortest path request is computed as: RequestTimeout_constant ms + 1000 * RequestTimeout_coefficient s/km * OD_distancekm Unit: ms |
RequestTimeout_ coefficient |
The timeout for the shortest path request (given in ms) is computed as: RequestTimeout_constant ms + 1000 * RequestTimeout_coefficient s/km * OD_distancekm Unit: s/km |
NumberOfArcPF ForTimeout |
Number of arc performance function calls to activate request timeout checking. |
Algorithm Calibration_nRequest |
Number of requests to do the algorithm calibration. |
Algorithm Calibration_nAttempsList |
Maximum number of attempts to find a random request for a specific distance class. If, for a distance interval, not all the request had been found, the calibration by is performed using only the created request. |
AlgorithmCalibration_ requestFilePathInput |
Absolute path of the file that contains the requests to import for calibration. If not specified, random requests are considered. |
AlgorithmCalibration_ modeList |
List of modes to consider for the calibration. Only the modes included in the list are randomly selected for the requests. |
AlgorithmCalibration_ fromDateString |
Initial date to consider to the requests in the algorithm calibration. If not specified, the calibration considers the Now Date. Format: yyyy/MM/dd HH:mm |
AlgorithmCalibration_ toDateString |
Final date to consider to the requests in the algorithm calibration. If not specified, the calibration will consider the From Date + 30 days. Format: yyyy/MM/dd HH:mm |
AlgorithmCalibration_ requestFilePathOutput |
Absolute path of the file that contains the requests randomly created for the calibration. If not specified, requests are not exported. |
AlgorithmCalibration_ CalibrationFilePath Output |
Absolute path of the file that contains the calibration result. If not specified, the result is exported to a file named AlgorithmCalibrationResult.txt, located in the same folder as Hyperpath.exe. |
AlgorithmCalibration_ costConstraintList |
Constraint for the cost indicator of the objective function. |
AlgorithmCalibration_ astarMinValueList |
A* parameter minimum values. |
AlgorithmCalibration_ astarMaxValueList |
A* parameter maximum values. |
AlgorithmCalibration_ |
Predefined step for incrementing the A* parameter when optimizing the algorithm. |
AlgorithmCalibration_ numberOfCostConstraint Violation |
Number of cost constraint violations to stop the calibration. If this number is negative, all steps between the minimum and the maximum A* values are considered. |
AlgorithmCalibration_ |
If TRUE, the optimization includes also the request that causes an error. |
SnodATTlist
Important: SnodATTlist must be considered DEPRECATED, starting from the version 19.5 (see → What’s new?). Information associated to the → User Defined Attributes (UDAs) should be used instead. |
List of street node attributes to import. Format: comma-separated list |
NumberOfZoneClusters | List of the number of clusters for each zone. Format: comma-separated list |
CluZoneAttrName | Attribute name for zone clustering. |