Difference between revisions of "User:Atrophicshiner/Guide to toll price mappping"

From Wazeopedia
(Blanked the page)
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
This guide is localised for editors from the UK.
== Access ==
The toll price mapping tool can be found at https://tolls.waze.com/welcome.html.
{{mbox|type=protection|text=You need to be registered to use this tool, your Waze credentials will not work by default. Access is restricted due to the complex nature of using the tool and the need for some control to be kept on what data is being submitted for public use. Contact [https://www.waze.com/forum/ucp.php?i=pm&mode=compose&u=1445148 Timbones] if you are interested in being part of toll price mapping.}}
== Tool interface ==
=== Welcome tab ===
Here you will find useful information such as announcements, descriptions and tutorials, and other links to related resources.
==== Resource links ====
'''Submit file for upload''' - Use this form to submit a toll file for upload to the client, the file '''must''' be saved as public
'''Road live in the app''' - This spreadsheet provides a list of all toll files that have been submitted for upload and their status. You will '''not''' get informed if the submitted file is approved or rejected. You '''must''' check here for details. Use search to find your username or the toll file name as the list is long.
'''Passes and correlations''' - You can request new passes to be added to the client or edit existing passes. The spreadsheet is ''restricted access'', if you '''must''' have access you should contact ''Timbones''.
=== Toll Prices tab ===
==== Open ====
Toll files have 4 statuses;
* <span style="color: #e1e1e1; background: #6b0c82;">&nbsp;production&nbsp;</span> - a file that has been uploaded and is being used to calculate toll prices in the client
* <span style="color: #e1e1e1; background: #7d757b;">&nbsp;prod old&nbsp;</span> - a file that has been edited since it was last uploaded, the previous version of this file is being use to calculate prices in the client app
* <span style="color: #fffdfd; background: #dd0000ab;">&nbsp;public&nbsp;</span> - a file that has been made available for all tool users to view and test
* <span style="color: #2c2c2c; background: #8ca7eeab;">&nbsp;private&nbsp;</span> - a file that only yourself, the creator, can see and test.
Using the My Files, Public, or the search box you can filter files as required. You can also <span style="color: #fff; background: #00a701b5;">&nbsp;load&nbsp;</span> a file for you to view and edit a local copy, or load a file into the <span style="color: #fff; background: #2821ccb5;">&nbsp;playground&nbsp;</span> for testing. You can only <span style="color: #fff; background: #990001b5;">&nbsp;delete&nbsp;</span> a file you have created.
==== Save and export ====
The large text box should display all of the input toll data that will be saved within the toll file, this is saved as a minified [http://www.json.org/ JSON] file.
You should choose a name that best reflects the toll(s) that as mapped in the file. The suggested naming convention is Country_State_Area. As the UK is relatively small we are grouping tolls into a single file: '''UK_Country_Roads'''.
{{Mbox|type=critical|text=The system will '''not''' check if you have already used the same file name and '''will''' overwrite any existing file you have already created. Any existing file data will be lost.}}{{Mbox|type=notice|text=You are unable to save a file with the same name that has already been used by another user.}}
When you save a file you can also select whether to <span style="color: #fffdff; background: #dd0000ab;">&nbsp;make public&nbsp;</span> and / or <span style="color: #fff; background: #2821ccb5;">&nbsp;load to playground&nbsp;</span> for testing.
==== Clear All ====
This clears all current tolls showing in the edit area. It does not delete files, nor remove loaded data from the playground.
{{Mbox|text=If you have '''not''' saved your work and clear the data it can '''not''' be retrieved.|type=critical}}
==== add tolls ====
This adds a new toll line into the edit area for you to map a toll and its pricing.
=== Playground tab ===
'''Show Waze Toll Segments for Current View''' - When zoomed in to a given area this will <span style="background: #ffca72;">&nbsp;highlight&nbsp;</span> segments mapped in WME using the toll attribute. The known segments do not update with map tile builds, nor does this show partial toll segments [those mapped with a toll-free restriction]. It is unknown if this ''snapshot'' will be updated.
'''Show Loaded Tolls''' - When you have a toll file loaded into the playground, via either the '''Open''' or '''Save and export''' menu, this will zoom to the corresponding area and <span style="color: #fff; background: #2727fd;">&nbsp;highlight&nbsp;</span> all tolls mapped within the file, based on the polyline data.
'''Clear Loaded Tolls''' - This will remove all tolls previously loaded into the playground. This is useful when you have changed a toll file and the old version was loaded into the playground and want to test the changes.
'''Find''' - Allows you to find a location based on WME permalink or segment ID.
==== Testing ====
'''User Permit ID''' - If you are testing a toll that has associated permits, also known as passes, enter the exact permit ID (''example: '''tollroad-uk'''''), leave blank for no permit.
'''Vehicle''' - Select the vehicle type you wish to use for testing.
'''Travel Day''' - Select the date you wish to test from the calendar or type the date (''format: '''MM/DD/YYYY''''').
'''Travel Time''' - Select the time of day you wish to test.
# To test a toll price you should first ensure you have loaded it into the playground
# You can then use the ''draw a line'' button (top centre of map). Choose your start (click once) and the end (click twice) to create a route
#* The route is based on WME segments and Waze routing algorithms, not the visible map
#* You do not need to select any intermediate points
#* You should ensure your start and end are clear of the highlighted toll price segment as the route must pass through the start node, segment, and end node to trigger the toll calculation
# The route should display a message box with details of the calculated price and a summary of the route will show in the left-hand panel
#* <span style="background: #ffcccc;">&nbsp;Red highlighted&nbsp;</span> routes are routes that have a toll price calculated, this includes a zero price (''example: '''£0.00''''')
#* <span style="background: #ccccff;">&nbsp;Blue highlighted&nbsp;</span> routes are routes that are FREE, no toll price calculation made
#You can now adjust '''User Permit ID''', '''Vehicle''', '''Travel Day''', and '''Travel Time''' to see how they influence the toll price.
#Click on the green arrow beside any of the summary routes in the left-hand panel to see the new price details. The price shown in the left-hand panel will '''not''' change
#Be sure to test for all possible permutations based on direction, time of day, day of week, vehicle type and any passes.
=== My Information tab ===
Here you can view and change your credentials for the toll tool.
== Creating a new toll ==
=== add tolls ===
Generally a toll authority can be wholly contained with a single toll block. The only technical reason to split a toll authority into multiple toll blocks is if prices require a mix of pricing rules.
* '''toll id <small>(''required'')</small>''' - Identify your toll. The suggested naming convention is Country-State-RoadName-Direction (''example: '''UK-Plymouth-TamarBridge'''''). You can map multiple directions in the same toll so the direction is not needed
* '''road local name <small>(''required'')</small>''' - Enter a name that identifies the toll road, try to match the official name
* '''currency <small>(''required'')</small>''' - Enter the symbol or letters used locally when prices are shown (''example: '''£''''')
* '''currency code''' - Select the ISO currency code to match your region (''example: '''GBP''''')
* '''comments''' - You can use this text box for any useful notes, the URL to the toll price details at minimum
* '''polyline''' - This is created by selecting the draw button or from the playground. Its purpose is to highlight the location / line of the toll road in the playground [''format: '''LINESTRING(12.34567890123456 23.456789012345678,34.567890123456789 45.67890123456789)''''']
* '''type''' - Select how the toll is charged
*: '''Static''' is a known price in advance
*: '''Dynamic''' is when the price varies due to unknown factors.
* '''rules <small>(''select 1 only'')</small>''' - Choose how the toll is charged
*: '''pay_per_section_count''' should be selected when the toll price is based on passing through a discrete number of collection points
*: '''entry_exit_price''' should be selected when a toll price is determined based on the entry point and exit point of the route
*: '''pay_per_section''' should be selected when a fixed toll is paid for passing though a collection point
* '''add_trip_charge''' - A one off fee that gets added onto the final toll price calculation
* '''add_entry_exit_matrix <small>(''only shows for entry_exit_price'')</small>''' - Allows you to create a pricing matrix for the toll
* '''add_entry_exit_rules <small>(''only shows for entry_exit_price'')</small>''' - Allows you to create pricing rules for the toll
* '''add permit_prices <small>(''only shows for pay_per_section_count'')</small>''' - Allows you to create permit prices for the toll
* '''[[#add sections|add sections]] <small>(''required'')</small>''' - Allows you to create sections for the toll
=== add sections ===
Each distinct structure (bridge, tunnel, junction, etc) should have its own section. For a single structures, multiple directions can be added to the same section as long as the toll price is the same for all directions.
* '''section id <small>(''required'')</small>''' - This must be unique for each section you map in an individual toll
* '''road local name <small>(''required'')</small>''' - Add something that corresponds to the toll you are pricing, this will help if you are using matrix pricing
* '''section local name <small>(''required'')</small>''' - Add something that corresponds to the toll you are pricing, this will help if you are using matrix pricing
* '''venue id''' - Do '''not''' use, this has been deprecated
* '''location <small>(''required'')</small>''' - Use the Choose button to get the coordinates of the toll you are mapping, it is suggested mark the toll booth or centre of the bridge / tunnel (''format: '''12.34567890123286,23.456789901234567''''')
* '''add areas''' - unknown at this time
* '''[[#add segments|add segments]] ''<small>(required)</small>''''' - Allows you to associate WME segments to the section
*: '''(*)''' - Allows you to auto populate segment details from a permalink containing multiple segment IDs (only works if the tool recognises the segments have the toll attribute.)
* '''[[#add prices|add prices]]''' - Allows you to create prices for the section
=== add segments ===
You should select a segment that users '''must''' pass through to prevent a scenario where Waze ''avoids'' a mapped toll price.
* '''permalink''' - Copy a single segment permalink from the WME that you wish to be associated with the pricing of a toll route
*: '''Populate''' - Click this button to auto fill the remaining details from the permalink
* '''id''' - This is the ID of the WME segment
* '''forwards''' - This is the direction you wish the price to be calculated, true = A to B, false = B to A
* '''fromNode''' - This is the ID of the node at the start of the segment in the given direction of travel
* '''toNode''' - This is the ID of the node at the end of the segment in the given direction of travel
{{Mbox|type=info|text=To have prices calculated in both directions of 2-way segment you will need to have 2 segments listed. One with A to B direction, the other with B to A direction.}}
=== add prices ===
* '''permit id''' -

Latest revision as of 08:38, 12 December 2019