How to Use the Unified Profile Mechanism

About Profile Inheritance

When introducing the Unified Profile Mechanism ("UPM"), the vehicle profiles of the PTV xRoute Server gained some changes. They are now subject to an inheritance mechanism which displays the differences of the individual profiles more clearly. You can find the vehicle profiles under <root>/conf/profiles. In principle, the profiles used in PTV xRoute Server can be divided into two categories:

• PTV xServer default profiles: profiles which have been generated specifically for the PTV xRoute Server.
• Reference profiles for PTV Map&Guide and PTV Smartour: profiles which are transferred from the corresponding products.

The following table should give you an overview of the existing profiles

In the PTV xServer profiles, the default profile forms the basis of the inheritance hierarchy. The child profiles only show attribute values which are different from those of the parent profile , or are not executed. For general information about the UPM, please see: About Profiles

The following image shows the inheritance hierarchy of the PTV xRoute profiles:

Example: delivery.xml

<Profile xmlns:ns2="http://www.ptv.de/com/ptvag/xserver/engines/xpoidbaccess" parent="default">
 <Common language="de" majorVersion="1" minorVersion="0" />
 <Routing majorVersion="2" minorVersion="0">
  <Course>
   <BasicDataRules>
    <VehicleSpecific>
	 <DeliveryVehicles segmentMalus="2005"/>
	</VehicleSpecific>
   </BasicDataRules>
  </Course>
  <Vehicle>
   <Legal>
    <LegalConditions isAuthorized="true" isDelivery="true"/>
   </Legal>
  </Vehicle>
 </Routing>
</Profile>

For the reference profiles, there is no exclusive, superordinate profile. Here the PTV Smartour profiles are derived from the appropriate PTV Map&Guide profile (if available). This procedure leads to following hierarchy:

New Reference Profiles

A new concept was created to highlight changes to the reference profiles more clearly. Besides the reference profiles explained above there are new reference profiles which are built up as follows:

• truck40t = Profile name
• _01 = Major version number
• -00 = Minor version number
• _M/S = product abbreviation - M = PTV Map&Guide ; S = PTV Smartour

The profiles with product abbreviations (mg, smt) should be replaced by these new profiles. On account of backward compatibility the "classic" profiles are still supported in the current version.

To produce a better comparison between the products PTV recommends to use the new reference profiles or derive your own specific profiles out of the new ones

With regards to the content there is no difference between the "classic" and the "new" reference profiles. Both have the current state of the respective profiles used in the corresponding products. The following table shows you the name changes of the reference profiles:

Note that the reference profiles are read-only. You can derive your own specific profiles out of the reference profiles using their inheritance hierarchy.

Important Notes

The following figure illustrates the entry point in order to modify the relevant vehicle parameters. Detailed information is provided in the section: About Profiles.

The following table lists a bundle of important attributes which differentiate the specific vehicle types based on physical and legal parameters. Therefore, the table below describes the meaning of the attributes located in the main branch "Routing/Vehicle".

The tables below now show you the new reference profiles default values of the attributes explained above. The most important physical attributes that differ between the profiles are highlighted in red.

PTV Map&Guide reference profiles

PTV Smartour reference profiles

The value of the attribute enabled of the AdditionalDataRules class at the reference profiles was changed from true to false. That is the only difference to the external used profiles used in PTV Map&Guide internet. That change had to be done because at PTV xServer there are no additional data layer delivered by default.

Example

This sample shows the usage of the Unified Profile Mechanism ("UPM"). The profiles are either placed in the file system identified by their specific names or handed over as code snippets, the so-called "snippet mechanism", using the caller context element in your request. This sample shows both capabilities.

The following sample shows a route in Luxembourg which has the destination in the pedestrian area of the Grand-Rue:

You can see the green dot in the Grand-Rue. There is no route to this point because it is a pedestrian area and the passing is not allowed for the most vehicles. A rout will be calculated because PTV xRoute should return always a response to the nearest passable segment.
The passing of the pedestrian area will be enabled in the next section with a profile or a XML snippet.

{
  "waypoints": [
    {
      "$type": "WaypointDesc",
      "linkType": "NEXT_SEGMENT",
      "fuzzyRadius": 0,
      "coords": [
        {
          "$type": "Point",
          "point": {
            "$type": "PlainPoint",
            "x": 681840,
            "y": 6371865
          }
        }
      ]
    },
    {
      "$type": "WaypointDesc",
      "linkType": "NEXT_SEGMENT",
      "fuzzyRadius": 0,
      "coords": [
        {
          "$type": "Point",
          "point": {
            "$type": "PlainPoint",
            "x": 681477,
            "y": 6372244
          }
        }
      ]
    }
  ],
  "options": null,
  "exceptionPaths": null,
  "details": {
    "manoeuvres": false,
    "texts": false,
    "nodes": false,
    "binaryPathDesc": false,
    "polygon": true,
    "detailLevel": "STANDARD",
    "dynamicInfo": false,
    "segments": false,
    "segmentAttributes": false,
    "manoeuvreAttributes": false,
    "brunnelManoeuvres": false,
    "urbanManoeuvres": false,
    "manoeuvreGroups": false,
    "manoeuvreGroupRatio": 0,
    "tollManoeuvres": false,
    "boundingRectanglesC": 0,
    "boundingRectanglesOffset": 0,
    "totalRectangle": false
  },
  "callerContext": {
    "properties": [
      {
        "key": "Profile",
        "value": "truckfast"
      },
      {
        "key": "ResponseGeometry",
        "value": "PLAIN"
      },
      {
        "key": "CoordFormat",
        "value": "PTV_MERCATOR"
      }
    ]
  }
}

{
  "info": {
    "distance": 1189,
    "time": 194,
    "cost": 2347
  }

Use an xml profile

To enable the passing in the pedestrian area UPM can be used.

• Please save the file truck-delivery.xml to the configuration directory <root path>\conf\profile.
• Then change the profile in the CallerContext in the above request:

  "callerContext": {
    "properties": [
      {
        "key": "Profile",
        "value": "truck-delivery"
      }, .....
  

• Please execute the changed request in the PTV xServer Raw Request Runner. In the result you can see the distance:

  {
    "info": {
      "distance": 1286,
      "time": 256,
      "cost": 15996
    }
  

The resulting route is:

What we have done?
The profile truck-delivery.xml extends the profile truckfast:

<Profile xmlns:ns2="http://www.ptv.de/com/ptvag/xserver/engines/xpoidbaccess" parent="truckfast">			

<Routing majorVersion="2" minorVersion="0">
 <Course>
  <BasicDataRules>
   <VehicleSpecific>
    <DeliveryVehicles segmentMalus="2500"/>
   </VehicleSpecific>
  </BasicDataRules>
 </Course>
 <Vehicle>
  <Legal>
   <LegalCondition isAuthorized="true" isDelivery="true"/>
  </Legal>
  Vehicle>
</Routing>

Use the snippet mechanism

It is possible to change the profile without changing the PTV xServer conf directory with the "snippet mechanism".

• Set the profile again to truckfast in the CallerContext:

   {
    "key": "Profile",
    "value": "truckfast"
  }
  

• Set the snippet with the ProfileXMLSnippet of the CallerContext:

  "callerContext": {
    "properties": [
      {
       "key": "Profile",
        "value": "truckfast"
      },
    {
      "key": "ProfileXMLSnippet",
      "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
      <Profile xmlns:ns2=\"http://www.ptv.de/com/ptvag/xserver/engines/xpoidbaccess\
      "><Common language=\"de\" majorVersion=\"1\" minorVersion=\"0\"/>
      <Routing majorVersion=\"2\" minorVersion=\"0\"><Course><BasicDataRules>
      <VehicleSpecific><DeliveryVehicles segmentMalus=\"2500\"/></VehicleSpecific>
      </BasicDataRules></Course><Vehicle><Legal>
      <LegalCondition isAuthorized=\"true\" isDelivery=\"true\"/></Legal>
      </Vehicle></Routing></Profile>"	
    }

  In the snippet the < and > has not to be escaped for json.
  The value is nearly the same as the profile of the last example. It is without setting the parent parent="truckfast". This is forbidden in the snippet mechanism. The value defined by the property Profile in the CallerContext will be used as the parent: {"key": "Profile", "value": "truckfast"}
• Please execute the changed request in the PTV xServer Raw Request Runner. In the result you can see the distance:

  {
    "info": {
      "distance": 1286,
      "time": 281,
      "cost": 16270
    }

Copyright © 2024 PTV Logistics GmbH All rights reserved. | Imprint