[Script] WME Place Harmonizer: Version 1.1, Mar 2016

Discussion for the unofficial, community-developed addons, extensions and scripts built for the Waze Map Editor.

The official index of these tools is the Community Plugins, Extensions and Tools wiki page.

Moderators: Unholy, bextein, Glodenox, JustinS83

Forum rules
Discussion for the unofficial, community-developed addons, extensions and scripts built for the Waze Map Editor.

DO NOT START a new thread unless it is about a new idea. Keep discussion of existing tools within the main thread for that tool.

The official index of these tools is the Community Plugins, Extensions and Tools wiki page.

[Script] WME Place Harmonizer: Version 1.1, Mar 2016

Postby Bmtg » Wed Nov 04, 2015 12:22 am


Moderator note:

The author of this script is currently on an extended leave from Waze.

Until other provisions for this script are administered, please use the current working version of this script at this post.


WME Place Harmonizer (WMEPH)
Version 1.1

Summary:
This script acts on a single selected place to validate, format, and harmonize the information for the selected place. It pulls standardized info for over 800 chains from the PNH (Place Name Harmonization) data sheets. Places that are complete are automatically locked to the appropriate level based on category and location of the place (i.e. state/region/country rules are applied). Banners above the place information sidebar provide feedback on what is missing or out of spec with the place region's wiki guidance. Links to websites, search results, and PNH submission forms make working on places faster and easier. Hours can be added by pasting info from the place’s website or using shorthand entry. An optional highlighting feature shows places on the map needing work.

Who can use it:
Any editor rank 2 and up, editing in USA or Canada. (Some script options are restricted to higher ranked editors.)

How to use:
  • Select a place in WME.
  • Press the “Run WMEPH” button at the top of the sidebar (Screenshot), or press the keyboard shortcut. The default is Alt-Shift-A; you can change this in the WMEPH preferences panel. (use a lowercase letter if you don't want the Shift key in the shortcut) (Screenshot)
  • The script will run on the place, and colored banners will appear at the top of the sidebar with information on the place status.
    • Green indicates no major issues were found and place is locked. (Screenshot)
    • Blue indicates that minor issues were found, but place is locked. (Screenshot)
    • Orange indicates that something was found that potentially needs editor attention. (Screenshot)
    • Red means that an issue was found that prevented place locking. (Screenshot)
  • Banners contain buttons which do various things as described below
  • The script doesn’t automatically save, so you can always undo the changes it has made using the normal WME undo button.
  • After running the script, fix any missing or incorrect info. You can run the script multiple times and it will adjust to the updated info.
  • Once the place info looks good, save !
NOTE: The script sometimes offers links to search the web for a place's website. DO NOT copy and paste information from 3rd party sources like Google. Visit the place website and gather information from there instead.

Screencasts (Watch how it works!):
Basic example of a non-chain place
Basic example of a chain place
Basic example of duplicate finder and error checking
WMEPH Whitelisting Feature
Place Info Cloning Feature (Rank 3+)

Feature List
New in v. 1.1: Place Highlighter:
  • Place highlighting for all map markers shows places that need work. The highlighting works with your whitelisting settings. At this time, it does not check chain-specific errors. Options allow for disabling the use of Whitelist data and also suppressing highlights for the Missing Hours flag. (Highlight Key) (Sample Screenshot)
For chains on the PNH data sheet:
  • Names, Categories, and URL are updated from standard information, as long as the data has been approved by a moderator for your area. (Screenshot) New places and existing place approvals are always being added.
    • Note: The script matches places with PNH entries based on the place name. Some variation is accounted for, but misspellings and extraneous info in the place name may prevent a match. Feel free to report these to improve the matching algorithms.
  • Reminder messages for certain places are displayed, including hotel localization, special cases, alternate names, and optional place information. Some are easily applied with a single click (Screenshot).
  • Places on the sheet but not approved for the state/region provide a link to an approval form.
  • New chains can be submitted through the banner button. (Screenshot)
Place fields are checked and updated:
Category:
Name:
  • Place names are automatically capitalized, with option to force full Title Casing
  • Any alt-names are checked for search functionality, and unnecessary alt-names are removed (e.g., For Starbucks, starbuck and starbucks alts from the recent ad campaign are useless)
Description:
  • Updated from PNH data where applicable
  • Checked for special cases such as Pharmacy hours for some chains (Screenshot)
Lock level:
  • Places with complete address information and no major flags are locked according to the place category and the locking rules of the state/region
  • Places with invalid or bad info or not in line with wiki rules are not locked
Point vs. Area:
  • Places are checked for Point vs. Area based on the Places wiki and flagged. (Screenshot)
    • A button allows quick change to the right geometry type. When changing from area to point, the button uses the stop point as the location of the new point
  • Exceptions for states/regions are incorporated into the script. Please report any discrepancies
Address:
  • House numbers are checked for length and format, flagging anything out of spec, or if it’s missing. (Screenshot)
  • Street and City fields are flagged if missing
  • Street and City fields are flagged if missing
  • Checks HN against nearby addresses to see if there is a potential issue with the HN or street name
  • Places with “No Address” have no information at all, so the script uses nearest segments to infer country, state, city, and street information. This is used to refine searching, but also this can (optionally for R3+) be applied to the place point address fields. (Screenshot). (When running the script on PURs at low zoom, the script will not run on places with "No Address" since it needs to be zoomed to see the nearby streets. There is an option to enable auto-zoom for these cases.)
Website:
  • Unnecessary protocols such as http:// are stripped from URLs
  • Deep links (eg: store info pages) can be optionally preserved when matching from PNH data, as long as domains match
  • URLs are formatted (WWW -> www, etc.)
  • Banner buttons provide links to the store website or store locator page (some of which auto-fill the place location). (Store locator) (Web search) (Place website)
Phone:
  • Validates phone field for invalid area codes and exchanges, or incorrect number of digits. (Screenshot)
  • Flag Area codes that are out of state (Screenshot)
  • Reformats phone into proper style for the country/region/state. (Screenshot)
  • Alphanumeric phones like 1-800-CAR-4YOU can be entered in the phone field and the script will convert them.
Services:
  • Common services based on category can be optionally added automatically
  • Services can be toggled from the banners using clickable icons. (Screenshot)
Hours:
  • Places with unlikely hours are flagged. (Screenshot)
  • A 24/7 icon is available on the banners for quick addition of those hours. (Screenshot)
  • Places with missing hours are flagged and a text box is provided where you can enter the hours in two different ways. (Screenshot)
    • Copy the hours from the place website and paste into the box. You can either add to the existing hours for sequential adding, or use the replace button to replace any existing hours. The script tries to parse the pasted info and if the text is reasonably well-formatted, it automatically updates the hours in the WME place. Auto-switching to the More Info tab allows you to verify
    • You can enter hours in the box by typing them. Typically, enter the days followed with the times using 24hr time and/or am/pm. Use dashes for ranges of days and hours. You can use single (MTWRFSU), double (MoTuWe etc) or triple letter (MonTueWed etc) abbreviations for the days.
      • Example: M-W 9-17 ThSu 10-4p FriSat 9a-9p would set up the hours
        • Mon, Tue, Wed from 9a-5p
        • Thu & Sun from 10a-4p
        • Fri & Sat from 9a-9p
Gas Stations:
  • Brands are checked and flagged if they do not match the primary name. One click to update the name and move the existing name to the alt-name. (Screenshot)
  • “Unbranded” is flagged, since it is not used
  • Convenience Store category added to stations with one click, or optionally automatically. (Screenshot)
Residential Points:
  • Regular points with residential-type names such as “My House” are flagged
  • Residential points are stripped of unneeded information and (optionally) locked
Rest areas:
  • Detected based on names and categories
  • Names are checked against Wiki specs
Duplicate finder:
  • Highlights nearby places that have similar names, including whether they have photos on them. (Screenshot)
  • Optionally zooms and centers the map so that all nearby duplicates can be easily seen
Place Whitelisting:
  • Whitelisting buttons (‘WL’) appear on some banner flags, which adds the field to a list so that the script doesn’t consider that piece of information missing or out of spec ever again. For example, a park may have no house number; after pressing the WL button, the script will no longer indicate a severe error. Places that don’t operate a website can be WL’d, etc. (Screenshot)
  • Whitelists can be backed up and merged, enabling sharing between editors in the same area to avoid editors researching the same information multiple times. (Screenshot)
    • To backup and/or share a list, press the pull button and copy the retrieved information from the text box. Save locally or email to fellow editors.
    • To merge a list, first paste the list into the textbox and then press merge. Places on the new list will be added to any places already in your existing list, so no data is lost. This is also how you can restore a backup in case of data loss in the browser
    • To share a list to a public Google sheet, use the Share button, which links to a form where you can submit the data (limited data capacity at present)
    • To view your whitelist stats by state and country, use the Stats button
    • To remove all WL data for a single state, enter the state name as shown in the stats list, and use the Remove State button
  • Future feature: Whitelist info can be integrated with place highlighting so that editors can see which places still need review
Place Cloning (option for R3+):
  • Copy information from a selected place, then paste selected info into other places that share the same information. Examples: businesses in malls that share the same address; college campuses where all buildings share address, url, and phone; businesses that share the same street and city name. To use, enable the tool in the settings tab. It will appear under the Run WMEPH button when you select a place. (Screenshot) Select the place with the info you want to use for other places, and press copy. Select a place you want to clone the info to, and check the boxes for the info you want to clone:
    • HN = House Number
    • Str = Street
    • City = City, State, Country
    • URL
    • Ph = Phone
    • Desc = Description
    • Serv = Services
    • Hrs = Hours
    • 3 Buttons allow selection if all, none, or just the address fields
    Then, press paste, and the info will be applied to the selected place. Repeat with as many places as desired. Copied info is removed when WME is reloaded.

Convenient Zooming:
  • Press Ctrl-Alt-z. If you have a place selected, it zooms to the 50ft level and centers the place. If you don’t have a place selected, it zooms to the 200ft level, and centers it around where ever you have the mouse cursor at the time.

Installation:
Script works on Chrome and Firefox. Install from Greasy Fork using Tamper/Greasemonkey. Current version: 1.1.24

Greasy Fork Link

Beta testers welcome. Send a PM to bmtg to help with future features:
  • Support for other countries/languages (more info on that will be posted in a separate forum thread in the coming weeks)
  • Place highlighting based on completeness
  • Area scanner to find places needing work
  • And more!
Acknowledgements:
  • Script development team: bmtg, vtpearce, cardyin, jtsmith2, joyriding, fjsawicki, CoolCanuck, & sar85
  • PNH admins: tonestertm, t0cableguy, & ialangford; CoolCanuck
  • All the Beta testers and editors who submit bugs and feature requests
  • rickzabel & slemmon2 for solving some Firefox issues
  • All the WME script writers out there who have written many great codes
Last edited by Bmtg on Fri Mar 25, 2016 6:37 pm, edited 21 times in total.
Rank 5 Editor - Mentor

Important Links for New Editors
Welcome to Map Editing
Getting Started
Incorrect Edits

Waze Southeast specific Links (Alabama, Florida, Georgia)
Southeast Wiki
Join our regional Slack forum
Bmtg
Area Manager
Area Manager
 
Posts: 1060
Joined: Mon Jan 05, 2015 5:05 pm
Location: Tampa, FL USA
Has thanked: 463 times
Been thanked: 158 times

Re: [Script][Beta] WME Place Harmonizer

Postby carloslaso » Wed Nov 04, 2015 3:47 am

bmtg wrote:To do:
-- Continue to add more chains
-- Support for other US regions
-- Support for other Countries

Wish list (need help!):
-- access harmonization data from a table or formatted array

For your To Do list you could let us help you with support for other countries the same way rickzabel allows custom languages for his script.
[ img ][ img ]
Coordinador de Comunidad en México / Foro MX / Waze Status
Supervisor Noroeste México

iPhone XS Max / iOS 13ß / Waze ß 4.x
carloslaso
Global Champ Mentor
Global Champ Mentor
 
Posts: 3120
Joined: Fri Aug 20, 2010 1:30 am
Location: Sonora, Mexico
Has thanked: 1759 times
Been thanked: 2434 times

Re: [Script][Beta] WME Place Harmonizer

Postby Bmtg » Wed Nov 04, 2015 2:13 pm

Thanks, I will look into that approach.
Rank 5 Editor - Mentor

Important Links for New Editors
Welcome to Map Editing
Getting Started
Incorrect Edits

Waze Southeast specific Links (Alabama, Florida, Georgia)
Southeast Wiki
Join our regional Slack forum
Bmtg
Area Manager
Area Manager
 
Posts: 1060
Joined: Mon Jan 05, 2015 5:05 pm
Location: Tampa, FL USA
Has thanked: 463 times
Been thanked: 158 times

Re: [Script][Beta] WME Place Harmonizer

Postby crotalo » Thu Nov 05, 2015 2:18 pm

Thks, i Will try it


Enviado desde mi iPhone utilizando Tapatalk
Wazeopedia Colombia
Wiki Bogotá
Country Manager - Local Champ Colombia
crotalo
PartnerCoordinator
PartnerCoordinator
 
Posts: 765
Joined: Sat Nov 27, 2010 11:05 pm
Has thanked: 226 times
Been thanked: 1125 times

Re: [Script][Beta] WME Place Harmonizer

Postby ct13 » Thu Nov 05, 2015 11:00 pm

I like the script. Very, very good idea. I did want to make a few comments and suggestions.

If a place already has a url that is the same domain as the one on the harmonization list, remove the http or www, but leave everything after .com. Some areas don't mind location specific urls.

If I use your script on a place, save and then use it on the same place again, it still shows as an additional change. Was that intended?

For gas stations that belong to stores ( Walmart, Costco, Kroger, etc...) the name should not be changed to what is in the drop down box.

I am personally not a fan of the "services" check boxes in general. Can you add an option not to modify those, or point me to a place in the code where I can break that feature?

If we added regional lock standards for primary categories to the harmonization sheet or directly into your script could you add those?
ct13
US Waze Champs
US Waze Champs
 
Posts: 427
Joined: Sun Mar 25, 2012 9:59 pm
Location: Virginia
Has thanked: 163 times
Been thanked: 273 times

Re: [Script][Beta] WME Place Harmonizer

Postby Bmtg » Fri Nov 06, 2015 4:55 am

ct13 wrote:I like the script. Very, very good idea. I did want to make a few comments and suggestions.

If a place already has a url that is the same domain as the one on the harmonization list, remove the http or www, but leave everything after .com. Some areas don't mind location specific urls.

I will incorporate this into the script, and it can then be enabled by region.
ct13 wrote:If I use your script on a place, save and then use it on the same place again, it still shows as an additional change. Was that intended?

It was not, it's just a byproduct of not incorporating a comparison in the check yet. I have fixed that for general places in the version I just posted; I am reworking the harmonization places to also not change things if the fields are already ok, but that will be coming soon.
ct13 wrote:For gas stations that belong to stores ( Walmart, Costco, Kroger, etc...) the name should not be changed to what is in the drop down box.

True. I have accounted for three of these already in the script (Costco, Sams Club and BJs). I can add more, just need to know the common ones. I'll include Walmart, Kroger, and Frys, in the next release, feel free to mention any others.
ct13 wrote:I am personally not a fan of the "services" check boxes in general. Can you add an option not to modify those, or point me to a place in the code where I can break that feature?

I plan to make a tab for the script and that will be one of the options. If you want to break it at any point before that tab gets built, search for "var servMatch = true;" and change true to false.

ct13 wrote:If we added regional lock standards for primary categories to the harmonization sheet or directly into your script could you add those?

I can definitely add those. I have coded in all USA regions now so it will recognize the place's region wherever you edit. SE and SAT rules for high-lock places and exceptions are in place; I would just need the region and the conditions for locking or completeness that want to be met.

Thanks for the feedback, very much appreciated! Try out the new version, the alerts have been replaced with more informative banners.

Cheers
bmtg
Rank 5 Editor - Mentor

Important Links for New Editors
Welcome to Map Editing
Getting Started
Incorrect Edits

Waze Southeast specific Links (Alabama, Florida, Georgia)
Southeast Wiki
Join our regional Slack forum
Bmtg
Area Manager
Area Manager
 
Posts: 1060
Joined: Mon Jan 05, 2015 5:05 pm
Location: Tampa, FL USA
Has thanked: 463 times
Been thanked: 158 times

Re: [Script][Beta] WME Place Harmonizer

Postby Bmtg » Fri Nov 06, 2015 5:00 am

I have updated to v.0.82.

*** Please note that the shortcut method is now internal to the script. Shift-Alt-A. The reason for this is that it allows you to run the script while inside of a text box. For example, if you edit the name, you can run the script without having to click out.

The primary change in this version is that when you run the script, a banner now appears above the place editing panel on the top left, that tells you the status of the place after the script was run, including any warnings, missing info, and status. it's color coded for quick feedback: Green: Place is complete including phone & URL; Blue: Place is complete and locked, but missing phone and/or URL or may need manual confirmation of details; Orange: Place is formatted and locked, but the editor is urged to examine the message provided to verify the place details; Red: major issue with place, such as no address or name, or incorrect place/area setting for category.

Also in this version, running a script on a place that meets spec entirely should produce no changes to save, **except for places on the harmonization list. I am working on removing redundant edits from that part of the code.
Rank 5 Editor - Mentor

Important Links for New Editors
Welcome to Map Editing
Getting Started
Incorrect Edits

Waze Southeast specific Links (Alabama, Florida, Georgia)
Southeast Wiki
Join our regional Slack forum
Bmtg
Area Manager
Area Manager
 
Posts: 1060
Joined: Mon Jan 05, 2015 5:05 pm
Location: Tampa, FL USA
Has thanked: 463 times
Been thanked: 158 times

Re: [Script][Beta] WME Place Harmonizer

Postby ct13 » Fri Nov 06, 2015 2:22 pm

The idea to move the "unharmonized" name to the alt name box was a great idea by the way, A+ for that.
Would you prefer that I add these requests to the harmonization list or do you handle gas stations differently in your script? Let me know, I'm happy to do any legwork (I'm the harmonization list mod for my region).
ct13
US Waze Champs
US Waze Champs
 
Posts: 427
Joined: Sun Mar 25, 2012 9:59 pm
Location: Virginia
Has thanked: 163 times
Been thanked: 273 times

Re: [Script][Beta] WME Place Harmonizer

Postby Bmtg » Fri Nov 06, 2015 4:17 pm

Categories are handled differently but the data comes from the harmonization sheet so adding it there will make it's way onto the script soonish. Put any exceptions in the notes field of the sheet, and I'll try to account for them in the script wherever possible.

Cheers
Rank 5 Editor - Mentor

Important Links for New Editors
Welcome to Map Editing
Getting Started
Incorrect Edits

Waze Southeast specific Links (Alabama, Florida, Georgia)
Southeast Wiki
Join our regional Slack forum
Bmtg
Area Manager
Area Manager
 
Posts: 1060
Joined: Mon Jan 05, 2015 5:05 pm
Location: Tampa, FL USA
Has thanked: 463 times
Been thanked: 158 times

Re: [Script][Beta] WME Place Harmonizer

Postby tonestertm » Fri Nov 06, 2015 6:11 pm

I haven't actually had a chance to look at the script/interface etc. yet, having only just seen this for the first time, but a couple of quick comments before i actually get lost in it:

-This looks like a GREAT idea, on the whole, and is exactly the sort of thing I was hoping for at the creation of Harmonization.

-I disagree with automatically adding Convenience Store to every Gas Station (Big Box exceptions noted). I think this is something that should be discussed in the Harmonization group.

-I would like to suggest an automatic add of ATM to every Bank, but that would get dicey, separating the Banks from other Financial Institutions. Also there are cases where, for only one example, Wells Fargo Bank has non-banking locations. Maybe something clever can be figured, like a checkbox to add, or add it with a warning to check, or something....

-Is there a possibility of automatically checking for "duplicates" nearby (some of which are likely misnamed)? This would be immensely helpful. Also would be nice to have a way to compare those (especially photos) before setting this to work on one and deleting the other(s).

Edit: Note that additional chains should be added through the Harmonization Form for the region.

...there were a couple of other thoughts I had, but I'll have to wait for them to come back :( and I'm sure there will be more. :)

One more edit: A while back I went through and made up this sheet, which is a collection of all the Waze specific Keyboard Shortcuts I could find at that point. It needs some updating, but might be a place to start:
https://docs.google.com/spreadsheets/d/ ... edit#gid=0

Looking forward to working with you.
Thanks for all your and vtpearce's work on this! Wish I'd known about it sooner. :)

Cheers!
[ img ]
ARC for SW Region, USA
US Local Champ, US Country Manager
The best editors Read the Wiki and read it often. Learn the proper way to handle URs. Don't draw another Place until you read this!
tonestertm
US Waze Champs
US Waze Champs
 
Posts: 1288
Joined: Wed Nov 14, 2012 12:02 pm
Location: City of...um, Angels, CA, USA
Has thanked: 523 times
Been thanked: 896 times

Next

Return to Addons, Extensions, and Scripts

Who is online

Users browsing this forum: ehepner1977, ldriveskier