bigfish BF Store Locator.doc Last Updated: 3-Jul-2013

Transcription

1 bigfish BF Stre Lcatr.dc Last Updated: 3-Jul

2 TABLE OF CONTENTS 1 Mdificatin Histry Stre Lcatr Overview Stre Lcatr Indexing Stre Lcatr Functin Defining a Stre Basic Definitin Cuntry Cnsideratins Future Cnsideratins Stre Lcatr Access t Stre Lcatr Visual Guideline (Initial Display) Visual Guideline (Return Results) N Results Fund Visual Guideline (Stre Detail) Visual Guideline (Stre Selectr Mde) Technical Ntes Related Dcumentatin OFBiz Database Mapping Multi-Stre Cnsideratins Implementatin Details Scheduled Jb Parameters Admin Mdule

3 1 Mdificatin Histry Date Wh Cmments 29-Nv-11 Slveda Initial 1-Dec-11 Slveda Added status: PARTY_ENABLED = Open PARTY_DISABLED = Clsed 11-Jan-12 Slveda Added icns fr Directins (Car, Walk, Bicycle) 19-Jan-12 Slveda Display new attribute Stre Ntice 19-Jan-12 Slveda Allw Stre-Lcatr t be used in select mde t accmmdate the pickup-in-stre functin (see BF-Cart-and- Check-Out fr related details) 16-Feb-12 Slveda Added Stre Prfile page 31-Jul-12 Slveda Added parameters GMAP_PICKUP_MAP_IMG_H and GMAP_PICKUP_MAP_W t cntrl the size f the map displayed in the Select a Stre functin. 3-Jul-13 Slveda Use GMAP_NOT_FOUND_ADDRESS when n results fund using the custmer request 3

4 2 Stre Lcatr Overview 2.1 Stre Lcatr Indexing ADMIN MODULE Maintain Stres OFBIZ DB Stre Infrmatin SCHEDULED JOB Find Stres that have nt been indexed. Use Ggle GEO-Cding API. GOOGLE GEO SERVICES Stre ge-cde (lng/lat) back in database fr that Stre OFBIZ DB: this is the repsitry fr all the Stre Infrmatin ADMIN MODULE: allws users t maintain Stre Infrmatin SCHEDULED JOB: nightly r ad-hc executed jb that will read all Stres that d nt have GEO-CODE infrmatin and update 4

5 2.2 Stre Lcatr Functin OFBIZ DB Stre Infrmatin ecmmerce Implementatin Custmer enters address in Stre Lcatr Match Algrithm Cnvert entered-address t GEO-Cde (lng/lat) GOOGLE GEO SERVICES Using entered-lng-lat, find all stres within n miles/kms and restrict t n results Send entered-lcatin and matching stres t ggle. Will return map with pins GOOGLE MAP SERVICES Display results t custmer OFBIZ DB: this is the repsitry fr all the Stre Infrmatin ECOMMERCE: the client implementatin, accepts an address frm the user, cnverts the address t a ge-cde and matches against available stres 5

6 3 Defining a Stre 3.1 Basic Definitin A Stre will be defined as fllws: Attribute Stre Name Stre Cde Address-1 Address-2 City State Zip Phne Number Opening Hurs Lng Lat Status Descriptin A full name that describes the stre An abbreviated cde Address Address City State Zip Phne Number Text f stre hurs The lngitude lcatin f the Stre The latitude lcatin f the Stre PARTY_ENABLED = Open PARTY_DISABLED = Clsed Stres with a PARTY_DISABLED status shuld NOT be displayed n the Stre Lcatr Page Stres that have nt yet been ge-cded shuld NOT be displayed n the Stre Lcatr Page 3.2 Cuntry Cnsideratins The definitin f a stre shuld cnsider cuntry See spec BF Cuntry Cnsideratins.dc fr mre details. 3.3 Future Cnsideratins It is likely that future implementatins will require additinal cntent. Cnsider: Manager s Pht and Bi Staff Infrmatin Stre specific special ffers Other stre specific cntent 6

7 4 Stre Lcatr 4.1 Access t Stre Lcatr Typically the Stre Lcatr will be implemented as a link with either the header r fter cntent ( SITE_INFO cmpnents). The slutin must be implementatin in such a way s that it is easily included as a simple link / image within the final ecmmerce slutin. Opening Hurs and Stre Ntice shuld nly be displayed if cntent is available 4.2 Visual Guideline (Initial Display) Stre Lcatr Page Cntent Spt: Cntent Menu: PAGE_TOP_SPOT (MENU_CONTAINER) Cntent ID: PTS_STORE_LOCATOR [Message Area] Find a stre nearby. Enter the address, city, state r zip frm where yu want t search fr a stre. Address, City, State r Zip: Search 7

8 4.3 Visual Guideline (Return Results) Stre Lcatr Page Cntent Spt: Cntent Menu: PAGE_TOP_SPOT (MENU_CONTAINER) Cntent ID: PTS_STORE_LOCATOR [Message Area] Find a stre nearby. Enter the address, city, state r zip frm where yu want t search fr a stre. Address, City, State r Zip: Search 3.7 Miles 6.8 Miles 13.3 Miles City Stre (CS) 187 Main Street, Cityplace, NY Hurs: Every Day 7am 8pm Stre Ntice: Being renvated this weekend Phne: Beach Stre (BS) 189 Shre Drive, Seaside, NY Hurs: M-F 7am 10pm, Sat-Sun 8am 3pm Phne: Faraway Stre (FS) 189 Faraway Place, Lngtwn, NY Hurs: Wed nly 7am 8am Phne: The Stre Detail ptins (the link and the icn) are nly displayed if there is available STORE_CONTENT_SPOT infrmatin 8

9 4.4 N Results Fund If the initial query returns zer results then: The system parameter GMAP_NOT_FOUND_ADDRESS may prvide an alternative search If this parameter is nt blank, then re-execute the search If results are fund with the alternative search then display them with the message: We are srry, we d nt have stres within [GMAP_RADIUS] [GMAP_UOM] f the address yu entered. Shwing results fr [GMAP_NOT_FOUND_ADDRESS] instead If n results are fund If the initial search returned zer results and the GMAP_NOT_FOUND_ADDRESS is blank OR If the initial search returned zer results AND the alternative search returned zer results We are srry, we d nt have stres within [GMAP_RADIUS] [GMAP_UOM] f the address yu entered Message shuld be cnfigurable via Labels-and-Captins 4.5 Visual Guideline (Stre Detail) Accessed frm clicking n the Stre link r the Stre icn Page title is the Stre Name The Stre Cntent Spt is displayed beneath the H1 The map, with driving directins t the selected stre is displayed The stre details are displayed City Stre Stre Name: City Stre (CS) Address: 187 Main Street CityPlace, NY Hurs: Every Day 7am 8pm Ntices: Being renvated this weekend Phne: Stre Cntent Spt ges here 9

10 TURN BY TURN DRIVING DIRECTIONS DISPLAYED IN THIS PANEL 3.7 Miles Back 10

11 4.6 Visual Guideline (Stre Selectr Mde) Stre Lcatr Page Cntent Spt: Cntent Menu: PAGE_TOP_SPOT (MENU_CONTAINER) Cntent ID: PTS_STORE_LOCATOR [Message Area] Find a stre nearby. Enter the address, city, state r zip frm where yu want t search fr a stre. Address, City, State r Zip: Search Select fr Pickup 3.7 Miles Select fr Pickup 6.8 Miles Select fr Pickup 13.3 Miles City Stre (CS) 187 Main Street, Cityplace, NY Hurs: Every Day 7am 8pm Phne: Beach Stre (BS) 189 Shre Drive, Seaside, NY Hurs: M-F 7am 10pm, Sat-Sun 8am 3pm Phne: Faraway Stre (FS) 189 Faraway Place, Lngtwn, NY Hurs: Wed nly 7am 8am Phne: Cancel Stre Select This will return yu t the check-ut prcess Cancel Stre Select shuld be ffered in the Initial View in rder t prvide a way t return t the check-ut prcess befre starting a stre search r when stres are nt available in the search area Clicking n Select fr Pickup will redirect back t the calling page with the selected Stre 11

12 Clicking n Cancel Stre Selectin will execute a brwser back actin 12

13 5 Technical Ntes 5.1 Related Dcumentatin See dcument BF-Admin-Mdule-Stres fr additinal technical details 5.2 OFBiz Database Mapping The Stre infrmatin will be held primarily within the PARTY and assciated entities: PARTY PARTY_GROUP PARTY_ROLE PARTY_CONTENT PRODUCT_STORE_ROLE Using the PARTY cnstructs will allw additinal infrmatin t be stred withut restrictin in the PARTY_CONTENT entity The Rle Type will be STORE_LOCATION Address and ther cntact infrmatin will be stred in the fllwing entities: CONTACT_MECH POSTAL_ADDRESS TELECOM_NUMBER GEO-Cde infrmatin will be stred in the fllwing entities: GEO_POINT PARTY_GEO_POINT 5.3 Multi-Stre Cnsideratins Stres are assciated t a specific PRODUCT STORE via entity PRODUCT_STORE_ROLE assciating parties with a rle type f STORE_LOCATION. 5.4 Implementatin Details Fr a PHP based example see: When matching the available OFBiz Stres t the entered lcatin use the fllwing sample MySQL statement as a guide: SELECT id, ( 3959 * acs( cs( radians(37) ) * cs( radians( fbiz-stre-table.lat ) ) * cs( radians(fbiz-stre-table.lng ) - radians(-122) ) + sin( radians(37) ) * sin( radians(fbiz-stre-table.lat ) ) ) ) 13

14 AS distance FROM fbiz-stre-table HAVING distance < 25 ORDER BY distance LIMIT 0, 20; Where: 3959 is fr miles, use 6371 fr kilmeters 37 is the lngitude f the entered address -122 is the latitude f the entered address 25 indicates within 25 miles 20 limits the result set t 20 stres IMPORTANT 27-Jun-2013 It is imprtant t restrict the number f results (as illustrated by the LIMIT 0, 20 statement abve) since Ggle Maps restricts the number f hits frm a specific server. The hits (we think) include the number f pins served up by Ggle Maps. The limit is based n the system parameter GMAP_NUM_TO_DISPLAY 5.5 Scheduled Jb A scheduled jb is required: Retrieve all Stres with NO lng/lat infrmatin Call a Ggle API, accept lng/lat and update 5.6 Parameters Name Key Descriptin Seed Value GMAP_MAP_IMG_W GMAP Width f stre lcatr 300 map GMAP_MAP_IMG_H GMAP Height f stre lcatr 600 map GMAP_PICKUP_MAP_IMG_W GMAP Width f stre lcatr 200 map when used in select a stre GMAP_PICKUP_MAP_IMG_H GMAP Height f stre lcatr 400 map when used in select a stre GMAP_MAP_ZOOM GMAP Initial zm level f 4 display map GMAP_UOM GMAP Stre Lcatr unit f MILES measure. Values allwed are MILES r KILOMETERS. GMAP_RADIUS GMAP The Miles/Kilmeters t 20 use as the radius when matching GMAP_NUM_TO_DISPLAY GMAP The number f Stre matches t display (within 10 14

15 the Radius) GMAP_NOT_FOUND_ADDRESS GMAP An address that is used when n stres are fund using the custmers request. This shuld be a value that ensures results. GMAP_GEOPT_API_URL GMAP Request URL fr Getting Ge Pint Input as Address GMAP_JS_API_URL GMAP Request Url fr Shwing Ggle Map Input as Ge Pint (Lat,Lng) GMAP_JS_API_KEY GMAP Request Url Key fr Shwing Ggle Map Input as Ge Pint (Lat,Lng) m/maps/api/gecde/xml?s ensr=false aps?file=api&v=2&am p;key= ABQIAAAAtt0d8djaYFkk8N5 LJVcDSBQNclGH2vvMMwJjYtcwF78UzZg EBTN70S6uIgRAtXRkADN esbw5etg 15

16 6 Admin Mdule See BF-Admin-Mdule-Admin fr details f Stre Maintenance 16